Skip to main content
GET
/
api
/
partner
/
sandbox
/
v1
/
payout
/
{id}
Payout Status
curl --request GET \
  --url https://quickei.io/api/partner/sandbox/v1/payout/{id} \
  --header 'Authorization: Bearer <token>'
{
  "payout.payout_id": "<string>",
  "payout.reference": "<string>",
  "payout.amount": 123,
  "payout.currency": "<string>",
  "payout.fee": 123,
  "payout.total_deducted": 123,
  "payout.exchange_rate": 123,
  "payout.receiver_amount": 123,
  "payout.receiver_currency": "<string>",
  "payout.status": "<string>",
  "payout.description": "<string>",
  "payout.trx_id": "<string>",
  "payout.created_at": "<string>",
  "payout.processed_at": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.quickei.io/llms.txt

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

Retrieve the current status and details of a payout.

​
Path Parameters

​
id
string
required
The payout_id returned from the Execute Payout endpoint (e.g. POAB1C2D3E).

​
Example Request

curl -X GET https://quickei.io/api/partner/sandbox/v1/payout/POAB1C2D3E \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

​
Success Response 200

{
  "message": {
    "success": ["Payout details."]
  },
  "data": {
    "payout": {
      "payout_id": "POAB1C2D3E",
      "reference": "PAYROLL-2026-03-001",
      "amount": 100.00,
      "currency": "EUR",
      "fee": 2.50,
      "total_deducted": 102.50,
      "exchange_rate": 655.957,
      "receiver_amount": 65595.70,
      "receiver_currency": "XAF",
      "status": "completed",
      "description": "March 2026 salary",
      "trx_id": "PP8274619350",
      "created_at": "2026-03-29T14:01:15+00:00",
      "processed_at": "2026-03-29T14:01:15+00:00"
    }
  }
}

​
Payout Object Fields

​
payout.payout_id
string
Unique payout identifier (format: PO + 8 alphanumeric characters).
​
payout.reference
string
Your internal reference for this payout.
​
payout.amount
number
The amount sent (before fees), in currency.
​
payout.currency
string
The sender currency code.
​
payout.fee
number
Total fee charged.
​
payout.total_deducted
number
Total debited from your merchant wallet (amount + fee).
​
payout.exchange_rate
number
Applied exchange rate from sender to receiver currency.
​
payout.receiver_amount
number
Amount credited to the recipient’s wallet.
​
payout.receiver_currency
string
The recipient’s currency code.
​
payout.status
string
Current payout status: completed, pending, or failed.
​
payout.description
string
Description provided when creating the payout. May be null.
​
payout.trx_id
string
Quickei internal transaction ID. May be null if the payout failed before a transaction was created.
​
payout.created_at
string
ISO 8601 timestamp when the payout was created.
​
payout.processed_at
string
ISO 8601 timestamp when the payout was processed. null if still pending or failed.

​
Payout Statuses

StatusDescription
completedPayout executed successfully. Funds are in the recipient’s wallet.
pendingPayout is being processed (rare, most payouts complete instantly).
failedPayout failed. Merchant wallet was not debited.

​
Error Responses

StatusMessageCause
400Payout not found.Payout ID does not exist or does not belong to your merchant account
401Invalid API credentials.Bad or missing Bearer token