SwiftGoma.SwiftGoma

Search endpoints

Jump to any API endpoint by name, method, or path

Transactions & Ledger

Get payment ledger

GET/api/v1/payments/ledger

A unified ledger of every money movement on the platform — order payments, subscription payments, payouts, and refunds — regardless of provider or feature.

Requires Authorization
ADMIN, ACCOUNTANT only
Session

Query parameters

pagenumber
Defaults to 1.
limitnumber
Max 100. Defaults to 20.
sourcestring
e.g. ORDER_PAYMENT, SUBSCRIPTION_PAYMENT, ADMIN_PAYOUT.
directionstring
IN or OUT.
Request
curl --request GET \
  --url https://api.swiftgoma.com/api/v1/payments/ledger \
  --header 'Authorization: Bearer <access_token>'
200Example response
{
  "success": true,
  "data": {
    "entries": [
      {
        "id": "ledger_1a2b3c",
        "source": "ORDER_PAYMENT",
        "direction": "IN",
        "amount": "27.00",
        "currency": "USD",
        "status": "COMPLETED",
        "reference": "ord_5e6f7a",
        "label": "Paiement commande ord_5e6f7a",
        "provider": "mbiyopay",
        "createdAt": "2026-02-15T09:05:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 1,
      "totalPages": 1
    }
  }
}