GBPAY
Documentation

Construire avec GBPAY.

Authentification, découverte de produits, flux de transaction et référence Swagger complète.

BASE URLmygbpay.com/engine
AuthBearer JWT
Versionv1.0.0
FormatJSON
01
Authenticate
POST /login with your credentials and scope: "third-party" to get an access token (valid 5 min).
02
Discover products
Query countries and available products for your agent, or use the direct flow with a memberCode.
03
Quote & transact
Get a quote to lock fees, then submit the quote UUID to initiate. Poll status until SUCCESS or FAILED.
Read the full guide 
# Direct transaction (EXTERNAL_API agents)
curl -X POST https://mygbpay.com/engine/api/v1/trans/transaction/direct \
  -H "Authorization: Bearer <accessToken>" \
  -H "Content-Type: application/json" \
  -d '{
    "memberCode": "OM001",
    "productCategory": "CASH_OUT",
    "amount": 50000,
    "walletDestination": "237691234567",
    "debitTxReference": "YOUR-REF-001"
  }'

Authentification

EXTERNAL_API et Mobile Bank utilisent un JWT direct. Les agents POS passent par une double authentification OTP.

Ouvrir

Découverte des produits

Interrogez les pays et produits disponibles avant d'initier une transaction.

Ouvrir

Devis et transaction

Flow standard (devis puis initiation) pour MOBILE_BANKING et POS. Flow direct en un seul appel pour EXTERNAL_API.

Ouvrir

Statut de transaction

Interrogez le statut par polling ou abonnez-vous via SSE pour des mises à jour en temps réel.

Ouvrir

Webhooks

Configurez une URL de callback et un secret pour recevoir les événements de transaction en temps réel.

Ouvrir

Référence API

Spec OpenAPI complète. Explorez et testez tous les endpoints directement dans le navigateur.

Ouvrir

Explorez et testez tous les endpoints directement depuis le navigateur.

Open Swagger UI