Skip to main content
POST
Create a payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

A payment associated for a claim

claim
string<uuid>
required

The ID of the claim the payment should be reported on.

amount
object
required

The amount of the payment.

value_date
string<date>
required

The value date of the payment.

your_reference
string | null

Your unique reference.

Maximum string length: 255
metadata
object[]

The metadata object allows you to submit additional relevant information related to the payment as type/value pairs. You can submit an unlimited number of metadata sets.

Response

201 - application/json

A payment associated for a claim

href
string<uri>
required
read-only
claim
string<uuid>
required

The ID of the claim the payment should be reported on.

amount
object
required

The amount of the payment.

value_date
string<date>
required

The value date of the payment.

created
string<date-time>
required
read-only
id
string
your_reference
string | null

Your unique reference.

Maximum string length: 255
metadata
object[]

The metadata object allows you to submit additional relevant information related to the payment as type/value pairs. You can submit an unlimited number of metadata sets.