Skip to main content
GET
Lister vos opérations

Authorizations

x-api-key
string
header
required

Votre clé publique, préfixée gk_live_ (ou gk_test_).

x-api-secret
string
header
required

Votre secret, préfixé gs_live_ (ou gs_test_). Affiché une seule fois, à l'émission de la clé. Il ne doit jamais quitter vos serveurs.

Query Parameters

type
enum<string>
Available options:
CASHIN,
CASHOUT
status
enum<string>

État d'une opération.

  • CREATED — enregistrée, pas encore soumise
  • PENDING — soumise, en attente d'issue
  • AWAITING_PAYER — encaissement : le payeur doit agir
  • SUCCEEDED — aboutie (définitif)
  • FAILED — refusée (définitif)
  • EXPIRED — aucune issue dans le délai (définitif)
  • CANCELLED — annulée avant exécution (définitif)
  • REVERSED — contre-passée (définitif)

Une opération réussie ne repasse jamais en échec. Le seul mouvement possible depuis SUCCEEDED est REVERSED.

Available options:
CREATED,
PENDING,
AWAITING_PAYER,
SUCCEEDED,
FAILED,
EXPIRED,
CANCELLED,
REVERSED
country
enum<string>

Pays, en ISO 3166-1 alpha-2.

Available options:
CI,
BF,
ML,
SN,
TG,
BJ,
NE,
CM,
GN
Example:

"CI"

operator
enum<string>

Opérateur mobile money. Tous ne sont pas disponibles dans tous les pays — voir le guide « Pays et opérateurs ».

Available options:
ORANGE,
MTN,
MOOV,
WAVE,
DJAMO
Example:

"ORANGE"

externalReference
string

Votre propre référence d'opération.

Maximum string length: 120
from
string<date-time>

Borne basse de création, au format ISO 8601.

to
string<date-time>

Borne haute de création, au format ISO 8601.

limit
integer
default:50

Nombre maximum d'éléments renvoyés.

Required range: 1 <= x <= 200
offset
integer
default:0

Nombre d'éléments à ignorer avant de commencer la page.

Required range: x >= 0

Response

Page d'opérations.

total
integer
Example:

184

limit
integer
Example:

50

offset
integer
Example:

0

items
object[]