Skip to main content
POST
Transition disbursement status

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

disbursementId
string
required

Disbursement id

Body

application/json
toStatus
enum<string>
required
Available options:
allocated,
pending,
processed,
completed,
cancelled
disbursedAt
string

Response

{ success: true, disbursement }

success
boolean
required
{key}
any