Skip to main content
GET
/
payouts
List Payouts
curl --request GET \
  --url https://quickei.io/pay/sandbox/api/v1/payouts \
  --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 a paginated list of payouts for your merchant account.

​
Endpoint

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

​
Query Parameters

​
status
string
Filter by status: pending, processing, completed, failed
​
from_date
string
Start date filter in ISO 8601 format (e.g. 2026-03-01)
​
to_date
string
End date filter in ISO 8601 format (e.g. 2026-03-31)
​
page
integer
Page number (default: 1)
​
per_page
integer
Results per page (1–100, default: 20)

​
Example Request

GET /merchant-api/pos/v1/payouts?status=completed&from_date=2026-03-01&to_date=2026-03-31&page=1&per_page=20
Authorization: Basic {base64_credentials}

​
Success Response 200

{
  "message": {
    "success": ["Payouts retrieved"]
  },
  "data": {
    "payouts": [
      {
        "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"
      },
      {
        "id": "PYT-20260322-B7N3P1",
        "reference": "PAY-2026-0041",
        "amount": 50000,
        "currency": "XAF",
        "fee": 1000,
        "total_deducted": 51000,
        "status": "completed",
        "recipient": {
          "type": "bank_transfer",
          "bank_code": "AFRIFRPP",
          "account_number": "CM2100010001000000000123",
          "account_name": "Jean Dupont"
        },
        "description": "Supplier payment",
        "failure_reason": null,
        "processed_at": "2026-03-22T16:45:20+00:00",
        "created_at": "2026-03-22T16:40:00+00:00"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 42,
      "last_page": 3
    }
  }
}