Skip to main content
POST
Get Withdrawal Status

Authorizations

Authorization
string
header
required

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

Body

application/json

Provide exactly one of withdrawal_id or customer_withdrawal_id

withdrawal_id
string

The platform-assigned withdrawal ID

Example:

"w_9f8e7d6c5b4a3210"

customer_withdrawal_id
string

The user-specified withdrawal ID

Example:

"my-withdrawal-001"

Response

Withdrawal status result

success
boolean
required

Whether the request was successful

Example:

true

error
string

Error message, present only on failure

Example:

""

error_code
string

Semantic error code. See each endpoint's error responses for the specific codes it can return.

deprecated
string

Deprecation notice, if applicable

Example:

""

result
object