Pesalink - To Mobile Number
Test URL
POSThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/pesalinkMobile
Live URL
POSThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/remittance/pesalinkMobile
This web service enables an application to send money to mobile.
📘 PesaLink Participating Banks
To check whether your recipient's bank is participating on PesaLink, go to partners link (opens in a new tab) here.
200 Success Response Schema
Field Name | Field Type | Field Description |
---|---|---|
status | bool | Response status |
code | number | Response code |
message | string | Response message |
data | object | Response data |
transactionId | string | unique transaction id |
status | string | transaction status |
description | string | description |
Example Request
⚠️
In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.
Signature Formulae
transfer.amount+transfer.currencyCode+transfer.reference+destination.name+source.accountNumber
Request 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. |
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.bankCode | string | Yes | Bank code of the recipient's bank (e.g., 01 for a bank). |
destination.mobileNumber | string | Yes | Recipient's mobile number (e.g., 0722000000 ). |
transfer.type | string | Yes | Transfer type (e.g., PesaLink ). |
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. |
Example Request
curl -X POST \
-d '{
"source": {
"countryCode": "KE",
"name": "John Doe",
"accountNumber": "0011547896523"
},
"destination": {
"type": "mobile",
"countryCode": "KE",
"name": "Tom Doe",
"bankCode": "01",
"mobileNumber": "0722000000"
},
"transfer": {
"type": "PesaLink",
"amount": "40.00",
"currencyCode": "KES",
"reference": "692194625798",
"date": "2019-05-01",
"description": "Some remarks here"
}
}' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-H 'signature: e967CLKebZyLfa73/YYltjW5M4cHoyWeHi/5VDKJ64gOwKBvzHJRqJJrBBc34v2m4jyKkDMBtfRJeFlxbNisMAeBtkw0TRcD2LThFK27EOqLM3m8rQYa+7CJ2FhPhK+iOa4RUY+vTfkRX5JXuqOW7a3GHds8qyPaPe19cKUY33eAJL3upXnGnA3/PEhzjhb0pqk2zCI7aRzvjjVUGwUdT6LO73NVhDSWvGpLEsP0dH/stC5BoTPNNt9nY8yvGUPV7fmaPSIFn68W4L04WgePQdYkmD1UPApGcrl+L2ALY3lPaRfI6/N+0Y3NIWQyLgix+69k7V4EGolqejWdion+9A==' \
-L 'https://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/pesalinkMobile'
Example Response
Example Response
{
"status": true,
"code": 0,
"message": "success",
"data": {
"description": "Confirmed. Ksh 100.0 sent to 254764000000- John Doe from your account 1464968850106 on Fri Jun 24 11:07:02 EAT 2022. Ref 041108128674. Thank you",
"transactionId": "041108128674",
"status": "SUCCESS"
}
}