Fund Transfer Wallet
API Reference
Fund Transfer Wallet
Initiate a payment transaction to fund your transfer wallet. Use this endpoint to process payments via bank transfer, mobile money, or card payments. You will need to provide essential details like the service ID, transaction type, amount, and a callback URL for real-time status updates.
POST
Fund Transfer Wallet
Authorization
string
required
Basic authentication header of the form Basic
<encoded-value>, where <encoded-value> is the base64-encoded string username:password.Request Body
integer
required
Your unique service identifier. You’ll receive this when you register your service with us.
string
required
Your internal reference for this payment.
string
required
A unique identifier for this transaction. Ensure this is unique for each request to avoid duplicate transactions. Use this to track the transaction in your system.
string
required
The type of transaction. Use ‘DTTW’ for Deposit to Transfer Wallet.
number
required
The amount to be transacted. Use a decimal point for fractional amounts (e.g., 10.50).
string
required
The network provider for mobile money transactions. Use ‘MTN’ for MTN Mobile Money, ‘TEL’ for Telecel Cash, ‘AIR’ for AirtelTigo Cash, or ‘CRD’ for card payments.
string
required
You can use your service name or the purpose of the transaction as the nickname as this will be shown on the payers phone when they receive the payment request.
string
required
The payment method. Use ‘MOM’ for mobile money, ‘CRD’ for card payments, or ‘CRM’ for both card and mobile money.
string
required
The currency code for the transaction. For example, use ‘GHS’ for Ghanaian Cedi, ‘USD’ for US Dollars.
string
required
The currency value. This is typically the amount in the currency specified in the currency_code unless you’re dealing with a specific exchange rate scenario.
string
required
Your URL where we’ll send transaction status updates. Ensure this endpoint is set up to receive POST requests.
string
required
Your landing page after the transaction has been completed.
string
required
The timestamp of your request. Use the format YYYY-MM-DD HH:MM (e.g., ‘2024-06-28 12:46’).
Response
string
A human-readable message describing the result of the payment initiation.
string
A code indicating the status of the payment initiation. Refer to our response code documentation for details.
string
The payment page to redirect your app or users to for the actual payment.

