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 retrieve all withdrawal orders that are currently in a pending state for a given merchant. This is useful for building dashboards, reconciliation flows, or alerting systems that need to surface in-progress outbound transfers.
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 whose pending withdrawals you want to list.

​
Response

Returns a 200 OK with an array of pending withdrawal objects. Returns an empty array if there are no pending withdrawals.
​
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 state of the withdrawal. All items in this response will have state: "pending".
​
createdAt
string
ISO 8601 timestamp of when the withdrawal was created.
​
txHash
string
The on-chain transaction hash. This will typically be null for pending withdrawals that have not yet been broadcast.
curl --request GET \
  --url https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/withdrawals/pending \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "e3a1c2d4-f5b6-7890-abcd-ef1234567890",
    "address": "TRR8WbHdkLBqNJAXmjS5jT4xEtd7X9bWb",
    "amount": "50.00",
    "paymentMethodID": 1,
    "state": "pending",
    "createdAt": "2024-01-15T10:30:00Z",
    "txHash": null
  },
  {
    "id": "f4b2d3e5-a6c7-8901-bcde-fa2345678901",
    "address": "TJkYa8MN9CkZvTjZ6UVMb4cSr3eX2YpDq",
    "amount": "120.00",
    "paymentMethodID": 1,
    "state": "pending",
    "createdAt": "2024-01-15T11:45:00Z",
    "txHash": null
  }
]