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 fetch the full details of a single withdrawal order. Poll this endpoint to track the status of a withdrawal as it progresses from pending through to final settlement.
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 that owns the withdrawal.
​
withdrawalID
string
required
The UUID of the withdrawal order to retrieve.

​
Response

Returns a 200 OK with the withdrawal object on success.
​
id
string
The UUID of the withdrawal order.
​
address
string
The destination wallet address the funds are being sent to.
​
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. Possible values include pending, processing, completed, and failed.
​
createdAt
string
ISO 8601 timestamp of when the withdrawal was created.
​
txHash
string
The on-chain transaction hash. Populated once the withdrawal has been broadcast to the network; null if not yet submitted.
curl --request GET \
  --url https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/withdrawals/e3a1c2d4-f5b6-7890-abcd-ef1234567890 \
  --header 'Authorization: Bearer <token>'

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