Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iterapay.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to initiate a withdrawal from your merchant balance to an on-chain address. You must specify the destination address, the amount to withdraw, and the payment method to use for the transfer.
Both Bearer token and API key authentication are accepted for this endpoint. API keys are scoped to a specific merchant — ensure the key matches the merchantID in the path.

​
Path parameters

​
merchantID
string
required
The UUID of the merchant initiating the withdrawal.

​
Request body

​
address
string
required
The destination wallet address for the withdrawal. Ensure the address is valid for the selected payment method’s network.
​
amount
string
required
The amount to withdraw as a decimal string (e.g., "50.00"). Must not exceed your available balance.
​
paymentMethodID
number
required
The ID of the payment method (network/currency) to use for the transfer.

​
Response

Returns a 201 Created with the new withdrawal object on success.
​
id
string
The UUID of the newly created withdrawal order.
​
address
string
The destination wallet address.
​
amount
string
The withdrawal amount as a decimal string.
​
paymentMethodID
number
The ID of the payment method used for the transfer.
​
state
string
The current state of the withdrawal. Initial value is typically pending.
​
createdAt
string
ISO 8601 timestamp of when the withdrawal was created.
​
txHash
string
The on-chain transaction hash. This field is populated once the withdrawal is broadcast to the network; it may be null immediately after creation.
curl --request POST \
  --url https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "TRR8WbHdkLBqNJAXmjS5jT4xEtd7X9bWb",
    "amount": "50.00",
    "paymentMethodID": 1
  }'

{
  "id": "e3a1c2d4-f5b6-7890-abcd-ef1234567890",
  "address": "TRR8WbHdkLBqNJAXmjS5jT4xEtd7X9bWb",
  "amount": "50.00",
  "paymentMethodID": 1,
  "state": "pending",
  "createdAt": "2024-01-15T10:30:00Z",
  "txHash": null
}