Skip to main content
POST
Mark paid
Requires payout-batches:write. See the payout batches guide for behavior and examples.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Optional retry key, unique within the selected program. Reuse the same key, method, path and validated payload; a conflicting reuse returns 409.

Required string length: 8 - 200
Pattern: ^[\x21-\x7e]+$
X-Program-Id
string

Select the key's original program or a program provisioned by this exact key. Other owned programs remain inaccessible.

Path Parameters

id
string
required

Body

application/json
paymentReference
string
required
Required string length: 1 - 200
paidAt
string<date-time>

Response

Success. Monetary amounts use program currency; see companion documentation for resource fields.

Last modified on October 23, 2026