Skip to main content
POST
Confirm withdrawal request

Authorizations

Authorization
string
header
required

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

Body

application/json
signature
string
required

The payment owner's signature over the withdraw_authorization payload from POST /payments/withdraw.

state_token
string
required

Opaque state token returned by POST /payments/withdraw. Pass back unmodified.

polling_timeout
integer
default:300000

Maximum time in milliseconds to wait for the withdrawal to complete before returning a PENDING status.

Required range: 0 <= x <= 300000

Response

Withdrawal executed successfully

payment_id
string
required

ID of the payment to withdraw

status
enum<string>
required

Status of the withdrawal

Available options:
SUCCESS,
PENDING
transaction_hash
string | null
required

Blockchain transaction hash for the withdrawal, or null while the withdrawal is pending