> ## 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.

# Payout Status

> Check the status of a payout

Retrieve the current status and details of a payout.

## Path Parameters

<ParamField path="id" type="string" required>
  The `payout_id` returned from the [Execute Payout](/partner-api/05-payout) endpoint (e.g. `POAB1C2D3E`).
</ParamField>

## Example Request

```bash theme={null}
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`

```json theme={null}
{
  "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

<ResponseField name="payout.payout_id" type="string">
  Unique payout identifier (format: `PO` + 8 alphanumeric characters).
</ResponseField>

<ResponseField name="payout.reference" type="string">
  Your internal reference for this payout.
</ResponseField>

<ResponseField name="payout.amount" type="number">
  The amount sent (before fees), in `currency`.
</ResponseField>

<ResponseField name="payout.currency" type="string">
  The sender currency code.
</ResponseField>

<ResponseField name="payout.fee" type="number">
  Total fee charged.
</ResponseField>

<ResponseField name="payout.total_deducted" type="number">
  Total debited from your merchant wallet (`amount + fee`).
</ResponseField>

<ResponseField name="payout.exchange_rate" type="number">
  Applied exchange rate from sender to receiver currency.
</ResponseField>

<ResponseField name="payout.receiver_amount" type="number">
  Amount credited to the recipient's wallet.
</ResponseField>

<ResponseField name="payout.receiver_currency" type="string">
  The recipient's currency code.
</ResponseField>

<ResponseField name="payout.status" type="string">
  Current payout status: `completed`, `pending`, or `failed`.
</ResponseField>

<ResponseField name="payout.description" type="string">
  Description provided when creating the payout. May be `null`.
</ResponseField>

<ResponseField name="payout.trx_id" type="string">
  Quickei internal transaction ID. May be `null` if the payout failed before a transaction was created.
</ResponseField>

<ResponseField name="payout.created_at" type="string">
  ISO 8601 timestamp when the payout was created.
</ResponseField>

<ResponseField name="payout.processed_at" type="string">
  ISO 8601 timestamp when the payout was processed. `null` if still pending or failed.
</ResponseField>

## Payout Statuses

| Status      | Description                                                        |
| ----------- | ------------------------------------------------------------------ |
| `completed` | Payout executed successfully. Funds are in the recipient's wallet. |
| `pending`   | Payout is being processed (rare, most payouts complete instantly). |
| `failed`    | Payout failed. Merchant wallet was not debited.                    |

## Error Responses

| Status | Message                  | Cause                                                                |
| ------ | ------------------------ | -------------------------------------------------------------------- |
| `400`  | Payout not found.        | Payout ID does not exist or does not belong to your merchant account |
| `401`  | Invalid API credentials. | Bad or missing Bearer token                                          |