Authorization
Basic authentication header of the form Basic
<encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.Request Body
Your unique service identifier. You’ll receive this when you register your service with us.
Your internal reference for this payment.
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.
The type of transaction. Use ‘DTTW’ for Deposit to Transfer Wallet.
The amount to be transacted. Use a decimal point for fractional amounts (e.g., 10.50).
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.
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.
The payment method. Use ‘MOM’ for mobile money, ‘CRD’ for card payments, or ‘CRM’ for both card and mobile money.
The currency code for the transaction. For example, use ‘GHS’ for Ghanaian Cedi, ‘USD’ for US Dollars.
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.
Your URL where we’ll send transaction status updates. Ensure this endpoint is set up to receive POST requests.
Your landing page after the transaction has been completed.
The timestamp of your request. Use the format YYYY-MM-DD HH:MM (e.g., ‘2024-06-28 12:46’).
Response
A human-readable message describing the result of the payment initiation.
A code indicating the status of the payment initiation. Refer to our response code documentation for details.
The payment page to redirect your app or users to for the actual payment.