To Mobile Wallets
Test URL
POSThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/sendmobile
Live URL
POSThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/remittance/sendmobile
This enables your application to send money to telco :iphone: wallets across Kenya, Uganda, Tanzania & Rwanda. Kindly note in order to get a response you will need to test this in production.
200 Success Response Schema
Field Name | Field Type | Field Description |
---|---|---|
transactionId | string | unique transaction id |
status | string | transaction status |
Example Request
⚠️
In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.
Signature Formula
transfer.amount+transfer.currencyCode+transfer.reference+source.accountNumber
Request Body Parameters
Field Name | Data Type | Required | Description |
---|---|---|---|
source.countryCode | string | Yes | Source account country code (e.g., KE for Kenya). |
source.name | string | Yes | Source account name. |
source.accountNumber | string | Yes | Source account number (mobile number or account number). |
destination.type | string | Yes | Type of destination (e.g., mobile ). |
destination.countryCode | string | Yes | Destination account country code (e.g., KE for Kenya). |
destination.name | string | Yes | Name of the recipient. |
destination.mobileNumber | string | Yes | Mobile number of the recipient (e.g., 254722000000 ). |
destination.walletName | string | Yes | Wallet name (e.g., Mpesa ). |
transfer.type | string | Yes | Transfer type (e.g., MobileWallet ). |
transfer.amount | string | Yes | Transfer amount. |
transfer.currencyCode | string | Yes | Transfer currency code (e.g., KES for Kenyan Shillings). |
transfer.reference | string | Yes | Unique transaction reference number. |
transfer.date | string | Yes | Transaction date (e.g., 2019-05-01 ). |
transfer.description | string | Yes | Transaction description or remarks. |
transfer.callbackUrl | string | Yes | URL to which the callback will be sent after transaction completion. |
Example Request
curl -X POST \
-d '{
"source": {
"countryCode": "KE",
"name": "Security Test",
"accountNumber": "1450160649886"
},
"destination": {
"type": "mobile",
"countryCode": "KE",
"name": "John Doe",
"mobileNumber": "254722000000",
"walletName": "Mpesa"
},
"transfer": {
"type": "MobileWallet",
"amount": "200",
"currencyCode": "KES",
"reference": "S001946981113",
"date": "2019-05-01",
"description": "Some remarks here",
"callbackUrl": "https://webhook.site/46fdc0c2-98fa-4ac5-a7ca-91b7fcabbac7"
}
}' \
-H 'Authorization: Bearer {{access_token}}' \
-H 'Content-Type: application/json' \
-H 'signature: {{signature}}' \
-L 'https://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/sendmobile'
Example Response
Example Response
{
"status": true,
"code": -1,
"message": "Transaction has been successfully acknowledged, await final transaction status on callback",
"reference": "S001946909393",
"transactionId": "S001946909393"
}
On completion of the transaction, you will receive a callback on the callbackUrl provided in the request. The callback will have the following payload:
Callback Payload
{
"status": true,
"code": "0",
"message": "success",
"transactionReference": "S001946909393",
"data": {
"ResponseCode": "0",
"ReceiverMsisdn": "254708028398",
"Reference": "S001946909393",
"ResponseDescription": "254708028398 Jonh Wick",
"ThirdPartyTranID": "S001946909393",
"ReceiverName": "Jonh Wick"
}