Documentation
Build with GBPAY.
Authentication, your first API call, code samples and the full Swagger reference.
POST/api/v1/trans/transaction/direct
200 OK
{
"status": "SUCCESS",
"uuid": "93827410293847",
"transactionRef": "TXN-001",
"amount": 50000.00,
"agentCommission": 150.00,
"clientTotal": 51500.00
}Available endpoints
POST/auth/loginAuth
GET/config/countriesConfig
POST/trans/quoteQuote
POST/trans/transactionTx
GET/trans/transaction/:id/statusStatus
Zone CEMAC · 6 pays
Certification · GIMAC
Base URLmygbpay.com/backend
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.
# Direct transaction (EXTERNAL_API agents)
curl -X POST https://mygbpay.com/backend/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"
}'