IMT Pesalink - To Mobile
Test URL
POSThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/pesalinkMobile/imt
Live URL
POSThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/remittance/pesalinkMobile/imt
This web service enables an application to send money to mobile.
⚠️
This service is only available in Kenya
📘 Pesalink Participating Banks
To check whether your recipient's bank is participating on PesaLink, go to partners link (opens in a new tab)
200 Success Response Schema
Field Name | Field Type | Field Description |
---|---|---|
status | string | Response status |
code | number | Response code |
message | string | Response message |
data.transactionId | string | unique transaction id |
data.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+destination.name+source.accountNumber
Request Fields
Field Name | Field Type | Required | Description |
---|---|---|---|
source.countryCode | string | Yes | The country code of the sender's mobile number. |
source.name | string | Yes | The name of the sender. |
source.accountNumber | string | Yes | The account number of the sender (if applicable). |
sender.name | string | Yes | The name of the sender. |
sender.documentType | string | Yes | The document type (e.g., NationalId). |
sender.documentNumber | string | Yes | The document number of the sender. |
sender.countryCode | string | Yes | The country code of the sender. |
sender.mobileNumber | string | Yes | The mobile number of the sender. |
sender.email | string | Yes | The email address of the sender. |
destination.type | string | Yes | The type of destination (e.g., mobile). |
destination.countryCode | string | Yes | The country code of the destination. |
destination.name | string | Yes | The name of the recipient. |
destination.bankCode | string | Yes | The bank code of the recipient (if applicable). |
destination.accountNumber | string | No | The account number of the recipient (if applicable). |
destination.mobileNumber | string | Yes | The mobile number of the recipient. |
destination.documentType | string | Yes | The document type (e.g., NationalId) of the recipient. |
destination.documentNumber | string | Yes | The document number of the recipient. |
transfer.type | string | Yes | The type of transfer (e.g., Pesalink). |
transfer.amount | string | Yes | The amount to be transferred. |
transfer.currencyCode | string | Yes | The currency code (e.g., KES). |
transfer.date | string | Yes | The date of the transfer. |
transfer.description | string | No | A description of the transfer. |
Example Request
curl --request POST \
--url https://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/pesalinkMobile/imt \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--header 'signature: {{signature}}' \
--data '
{
"source": {
"countryCode": "KE",
"name": "John Doe",
"accountNumber": "0011547896523"
},
"sender": {
"name": "Sender Name",
"documentType": "NationalId",
"documentNumber": "12345",
"countryCode": "KE",
"mobileNumber": "0763000000",
"email": "sender.name@example.com"
},
"destination": {
"type": "mobile",
"countryCode": "KE",
"name": "A N.Other",
"bankCode": "03",
"accountNumber": "101080530003",
"mobileNumber": "0763123456",
"documentType": "NationalId",
"documentNumber": "123456"
},
"transfer": {
"type": "Pesalink",
"amount": "1000",
"currencyCode": "KES",
"date": "2022-12-15",
"description": "some remarks here"
}
}
'
Example Response
Example Response
{
"status": true,
"code": 0,
"message": "success",
"data": {
"transactionId": "",
"status": "SUCCESS"
}
}