Skip to main content

Deposit

Create a deposit transaction to request funds from user.

Deposit Funds Endpoint​

Endpoint: POST /api/deposit

Headers:

Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

Request Body:

{
  "amount": 1000,
  "currency": "XAF",
  "paymentMethod": "mobile_money",
  "phoneNumber": "+237123456789",
  "operator": "MTN",
  "country": "CM"
}

Parameters:

  • amount (number, required): Amount to deposit
  • currency (string, required): Currency code (XAF, XOF, etc.)
  • paymentMethod (string, required): Payment method (mobile_money, crypto)
  • phoneNumber (string, required for mobile_money): Phone number
  • operator (string, required for mobile_money): Mobile operator (MTN, ORANGE, etc.)
  • country (string, required for mobile_money): Country code (CM, CI, etc.)

Response:

{
  "status": "pending",
  "message": "Deposit initiated successfully",
  "data": {
    "transactionId": "API_DEP_123_1234567890",
    "gatewayTransactionId": "gw_tx_456",
    "amount": 1000,
    "currency": "XAF",
    "fee": 35,
    "environment": "sandbox"
  }
}