List Payouts

Retrieve payout history for the authenticated business.

This endpoint returns only payouts created through the API.

GET /v1/payouts

Headers

Header	Required	Description
`X-Api-Key`	Yes	Your API key

Query Parameters

Parameter	Type	Required	Description
`currency`	string	No	Filter by payout currency, for example `USD`, `EUR`, `GBP`, `USDT`, `USDC`, or `BTC`
`status`	string	No	Filter by payout status: `PENDING`, `FAILED`, or `SUCCESS`
`fromDate`	string	No	Start date for filtering in ISO 8601 format
`toDate`	string	No	End date for filtering in ISO 8601 format. This is treated as the end of the provided day
`page`	number	No	Page number for pagination. Defaults to `1`
`limit`	number	No	Number of items per page. Defaults to `20` and is capped at `100`

Example Request

curl -X GET "https://api.esca.finance/v1/payouts?status=SUCCESS&currency=USDT&fromDate=2026-04-01&toDate=2026-04-23&page=1&limit=20" \
  -H "X-Api-Key: your_api_key_here"

Example Response

{
  "status": true,
  "data": {
    "payouts": [
      {
        "payoutId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "type": "crypto",
        "currency": "USDT",
        "amount": 100,
        "fee": 0.25,
        "status": "SUCCESS",
        "protocol": "TRC20",
        "address": "TXqH4w2ZQ2C3Y5t4dKxzfPzF8w2141vJgb",
        "transactionHash": "abc123def456"
      },
      {
        "payoutId": "f7a8b9c0-d1e2-3456-abcd-ef7890123456",
        "type": "fiat",
        "currency": "USD",
        "amount": 500,
        "fee": 5,
        "status": "PENDING",
        "bankName": "Chase Bank",
        "bankAccountNumber": "0123456789"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 2,
      "totalPages": 1
    }
  }
}

Response Fields

Field	Type	Description
`status`	boolean	Indicates whether the request succeeded
`data.payouts`	array	List of payouts matching the supplied filters
`data.pagination.page`	number	Current page number
`data.pagination.limit`	number	Number of items returned per page
`data.pagination.total`	number	Total number of matching payouts
`data.pagination.totalPages`	number	Total number of available pages

Payout Object Fields

Field	Type	Description
`payoutId`	string	Unique payout identifier
`type`	string	Payout type: `fiat` or `crypto`
`currency`	string	Payout currency
`amount`	number	Payout amount
`fee`	number	Fee charged
`status`	string	Current payout status
`protocol`	string	Blockchain protocol for crypto payouts only
`address`	string	Destination wallet address for crypto payouts only
`transactionHash`	string	Blockchain transaction hash when available
`bankName`	string	Destination bank name for fiat payouts only
`bankAccountNumber`	string	Destination bank account number or IBAN for fiat payouts only

Notes

Results are ordered from newest to oldest payout.
When both fromDate and toDate are provided, the endpoint returns payouts created within that date range.
When toDate is provided without a time, filtering includes payouts created up to the end of that day.

Error Responses

Status	Description
401	Invalid or expired API key
404	Account not found

Payout Status

Overview