Skip to main content
POST
Create mandate payment

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Idempotency-Key
string
required

Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.

Maximum string length: 255

Path Parameters

mandate_id
string<uuid>
required

UUID of the parent accepted case in this request.

Body

application/json

Payment input; the target is supplied exclusively by the URL.

amount
object
required

Amount received.

value_date
string<date>
required

Date on which the payment was credited; must not be in the future.

metadata
object[]

Metadata supplied when reporting the payment; duplicate types are allowed.

your_reference
string | null

Your reference for reconciling this payment.

Maximum string length: 255

Response

Read representation of one reported payment.

amount
object | null
required

Amount received.

claim
object | null
required

Claim to which the payment was reported.

created_at
string<date-time>
required
read-only

Time at which the payment was reported.

id
string<uuid>
required
read-only

Stable identifier of this reported payment.

mandate
object | null
required

Accepted case containing the claim.

metadata
object[]
required
read-only

Stored metadata entries; duplicate types remain separate entries.

updated_at
string<date-time>
required
read-only

Time at which the payment record was last updated.

value_date
string<date>
required
read-only

Date on which the payment was credited.

your_reference
string | null
required
read-only

Your reference for reconciling this payment.