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

Authorizations

X-Api-Key
string
header
required

Path Parameters

id
string
required

Payment ID

Body

application/json
status
enum<string>
required

The target payment status

Available options:
AWAITING_FUNDS,
PENDING,
PROCESSING,
SENT,
COMPLETED,
CANCELED,
FAILED,
EXPIRED,
REFUNDED,
SCHEDULED,
UNDER_REVIEW
Example:

"COMPLETED"

failure_reason
string

Reason for failure (required when status is FAILED)

Example:

"Insufficient funds"

Response

Payment status transitioned