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
payment_id
string
required

ID of the payment to withdraw

token_amounts
object[]
required

List of token amounts to withdraw back to the owner or to a requoted processing address

recipient_address
string
required

On-chain address to withdraw the funds to, on the same chain as the assets to withdraw.

owner_signature
string
required

The payment owner's signature on the withdrawal_authorization, authorizing the withdrawal

withdraw_account
enum<string>
default:SPW

Type of account to withdraw from. Use the account value from the balance result.

Available options:
INTENT,
SPW
payload
string

The withdraw_authorization string returned from the POST /payments/withdraw response.

Response

Withdrawal executed successfully

payment_id
string
required

ID of the payment to withdraw

transaction_hash
string
required

Blockchain transaction hash for the withdrawal