Skip to main content
GET
Get 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.

If-None-Match
string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

id
string<uuid>
required

UUID of the payment in this request.

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.