Skip to main content
POST
Create a payment
This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.

Autorisierungen

Authorization
string
header
erforderlich

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

Body

A payment associated for a claim

claim
string<uuid>
erforderlich

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

amount
object
erforderlich

The amount of the payment.

value_date
string<date>
erforderlich

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.

Antwort

201 - application/json

A payment associated for a claim

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

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

amount
object
erforderlich

The amount of the payment.

value_date
string<date>
erforderlich

The value date of the payment.

created
string<date-time>
erforderlich
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.