Skip to main content
PATCH
Transition a settlement request status (sandbox only)

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Settlement request ID

Body

application/json
status
enum<string>
required

The target settlement request status

Available options:
REQUEST_STARTED,
REQUEST_EXPIRED,
REQUEST_CANCELED,
REQUEST_COMPLETED,
REQUEST_REFUNDED,
FUNDS_SENT,
FUNDS_RECEIVING_LATE,
SETTLEMENT_SENT,
SETTLEMENT_COMPLETED,
AWAITING_PAYIN_RECONCILIATION,
PAYIN_CANCELED,
PAYIN_UNDER_REVIEW,
PAYIN_FAILED,
PAYIN_AMOUNT_MISMATCH,
PAYOUT_CANCELED,
PAYOUT_UNDER_REVIEW,
PAYOUT_FAILED
Example:

"SETTLEMENT_COMPLETED"

failure_reason
string

Reason for failure (when transitioning to a failure status)

Example:

"Payment rejected by provider"

Response

Settlement request status transitioned