Passer au contenu principal
GET
List payments

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.