Skip to main content
POST
/
payments
/
withdraw
Return funds to owner or retry payment
curl --request POST \
  --url https://v2.prod.halliday.xyz/payments/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_id": "<string>",
  "token_amounts": [
    {
      "token": "ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "amount": "<string>"
    }
  ],
  "recipient_address": "<string>",
  "withdraw_account": "SPW"
}
'
{
  "signature_type": "EIP712",
  "payment_id": "<string>",
  "withdraw_authorization": "<string>",
  "state_token": "<string>"
}

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. The assets will go to the address on the same chain the assets are on.

​
withdraw_account
enum<string>
default:SPW

Type of account to withdraw from.

Available options:
INTENT,
SPW

Response

Withdrawal initiated successfully

​
signature_type
enum<string>
required

Signature type required for the withdrawal authorization.

Available options:
EIP712,
EIP191
​
payment_id
string
required

ID of the withdrawal transaction

​
withdraw_authorization
string
required

Authorization data to sign. For EIP712, this is a JSON string to parse and pass to signTypedData. For EIP191, pass this string directly to signMessage.

​
state_token
string
required

Opaque state token to pass back when confirming the withdrawal.