Passer au contenu principal
GET
/
v1
/
payments
List payments
curl --request GET \
  --url https://api.sandpay.dev/v1/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "TX_8K3M9F",
      "parentTxId": null,
      "orderRef": "ORDER-2026-A1",
      "orderUrl": null,
      "isUrlProtected": false,
      "amount": 25000,
      "commission": 250,
      "netAmount": 25000,
      "customerTotal": 25250,
      "merchantAbsorptionPct": 100,
      "merchantShare": 250,
      "customerShare": 0,
      "commissionMode": "customer",
      "currency": "FCFA",
      "country": "CI",
      "msisdn": "+22507123456",
      "reference": "ZANA-PAY-20260531221015-8E2884A47B1C",
      "latencyMs": 1240,
      "createdAt": "2023-11-07T05:31:56Z",
      "raw": {
        "_simulated": true,
        "amount": "25000",
        "currency": "FCFA",
        "externalId": "ORDER-2026-A1",
        "payer": {
          "partyIdType": "MSISDN",
          "partyId": "22507123456"
        },
        "payerMessage": "Payment",
        "payeeNote": "ORDER-2026-A1",
        "status": "SUCCESSFUL",
        "financialTransactionId": "SIM_A1B2C3D4"
      }
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

Autorisations

​
Authorization
string
header
requis

API key in format sp_sk_test_... or sp_sk_live_....

Paramètres de requête

​
limit
integer
défaut:50

Maximum number of payments to return (1–100).

Plage requise: 1 <= x <= 100
​
country
string

ISO-3166 2-letter country code filter (e.g. CI, SN).

Required string length: 2
​
operator
enum<string>

Operator code filter.

Options disponibles:
mtn,
orange,
moov,
airtel
​
status
enum<string>

Final payment status filter.

Options disponibles:
SUCCESS,
PIN_INVALID,
INSUFFICIENT_FUNDS,
TIMEOUT,
ACCOUNT_BLOCKED,
USER_CANCELLED,
UNKNOWN_MSISDN,
LIMIT_EXCEEDED,
SERVICE_UNAVAILABLE,
DUPLICATE_REFERENCE,
PENDING
​
type
enum<string>

Transaction direction filter (collection / refund / disbursement). Transaction direction (B119): collection (pay-in, customer → merchant), refund (payout reversing a collection), or disbursement (free-form payout, merchant → an msisdn).

Options disponibles:
collection,
refund,
disbursement
​
cursor
string

Opaque pagination cursor returned by a previous call.

Réponse

Paginated list of payments.

​
data
object[]
requis
​
nextCursor
string | null
requis

Cursor to pass back as cursor to fetch the next page.

​
hasMore
boolean
requis

True if there are more payments after this page.