Skip to main content
GET
/
payouts
/
{payout_id}
Get Payout
curl --request GET \
  --url https://quickei.io/pay/sandbox/api/v1/payouts/{payout_id} \
  --header 'Authorization: Bearer <token>'

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 full details and current status of a specific payout.

​
Endpoint

GET https://quickei.io/pay/sandbox/api/v1/payouts/{payout_id}

​
Path Parameters

​
payout_id
string
required
The payout ID (e.g. PYT-20260323-X4K9M2)

​
Response Fields

FieldDescription
idUnique payout identifier
referenceYour internal reference
amountPayout amount
currencyISO 4217 currency code
feeFee charged for the payout
total_deductedTotal deducted from wallet (amount + fee)
statuspending, processing, completed, failed
recipientRecipient details (type, account info)
descriptionPayout description
failure_reasonReason for failure (null unless failed)
processed_atISO 8601 timestamp when payout completed or failed (null while pending/processing)
created_atISO 8601 timestamp of payout creation

​
Example Request

GET /merchant-api/pos/v1/payouts/PYT-20260323-X4K9M2
Authorization: Basic {base64_credentials}

​
Success Response 200

{
  "message": {
    "success": ["Payout details retrieved"]
  },
  "data": {
    "id": "PYT-20260323-X4K9M2",
    "reference": "PAY-2026-0042",
    "amount": 10000,
    "currency": "XAF",
    "fee": 200,
    "total_deducted": 10200,
    "status": "completed",
    "recipient": {
      "type": "mobile_money",
      "mobile_code": "237",
      "mobile_number": "670000000",
      "operator": "mtn"
    },
    "description": "Salary March 2026",
    "failure_reason": null,
    "processed_at": "2026-03-23T10:31:15+00:00",
    "created_at": "2026-03-23T10:30:00+00:00"
  }
}

​
Error Response 404

{
  "message": {
    "error": ["Payout not found"]
  }
}