Get Payout Status

Check the status of a payout using its payout ID.

GET /v1/payouts/:payoutId

Headers

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

Path Parameters

Parameter	Type	Required	Description
`payoutId`	string	Yes	Payout UUID returned when the payout was initiated

Example Request

curl -X GET "https://api.esca.finance/v1/payouts/f7a8b9c0-d1e2-3456-abcd-ef7890123456" \
  -H "X-Api-Key: your_api_key_here"

Example Response (Fiat)

{
  "status": true,
  "message": "Payout retrieved successfully",
  "data": {
    "payoutId": "f7a8b9c0-d1e2-3456-abcd-ef7890123456",
    "type": "fiat",
    "currency": "USD",
    "amount": 500,
    "fee": 5.00,
    "status": "SUCCESS",
    "bankName": "Chase Bank",
    "bankAccountNumber": "0123456789",
    "firstName": "John",
    "lastName": "Doe"
  }
}

For business beneficiaries, the response includes businessName instead of firstName/lastName.

Example Response (Crypto)

{
  "status": true,
  "message": "Payout retrieved successfully",
  "data": {
    "payoutId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "type": "crypto",
    "currency": "USDT",
    "amount": 100,
    "fee": 0.25,
    "status": "SUCCESS",
    "protocol": "TRC20",
    "address": "TXqH4w2ZQ2C3Y5t4dKxzfPzF8w2141vJgb",
    "transactionHash": "abc123def456..."
  }
}

Response 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	Payout status (see below)
`bankName`	string	Destination bank name (fiat only)
`bankAccountNumber`	string	Destination account number (fiat only)
`firstName`	string	Beneficiary first name (fiat individual only)
`lastName`	string	Beneficiary last name (fiat individual only)
`businessName`	string	Beneficiary business name (fiat business only)
`protocol`	string	Blockchain protocol (crypto only)
`address`	string	Wallet address (crypto only)
`transactionHash`	string	Blockchain transaction hash (crypto only, available after completion)

Status Values

Status	Description
`PENDING`	Payout is queued for processing
`PROCESSING`	Payout is being processed
`SUCCESS`	Payout completed successfully
`FAILED`	Payout failed

Error Responses

Payout Not Found

{
  "status": false,
  "message": "Payout not found."
}

This error is returned when:

The payout ID does not exist

Fiat Payout

List Payouts