Imt Mobile Wallets

Test URL

POSThttps://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/sendmobile/imt

Live URL

POSThttps://api.finserve.africa/v3-apis/transaction-api/v3.0/remittance/sendmobile/imt

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.

Signature Formula

transfer.amount+transfer.currencyCode+transfer.reference+source.accountNumber

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.

Request Fields / Parameters

`source` (Object) - Required

Field Name	Field Type	Field Description	Required
`countryCode`	string	The country code for the sender's account.	Yes
`name`	string	The name of the sender.	Yes
`accountNumber`	string	The sender's account number.	Yes

`sender` (Object) - Required

Field Name	Field Type	Field Description	Required
`name`	string	The name of the sender.	Yes
`documentType`	string	The type of the sender's document (e.g., `"NationalId"`).	Yes
`documentNumber`	string	The document number of the sender (e.g., `"12345"`).	Yes
`countryCode`	string	The country code for the sender.	Yes
`mobileNumber`	string	The mobile number of the sender.	Yes
`email`	string	The email address of the sender.	No

`destination` (Object) - Required

Field Name	Field Type	Field Description	Required
`type`	string	The type of destination (e.g., `"mobile"`).	Yes
`countryCode`	string	The country code for the destination wallet.	Yes
`name`	string	The name of the recipient.	Yes
`mobileNumber`	string	The mobile number for the recipient.	Yes
`walletName`	string	The name of the mobile wallet (e.g., `"Mpesa"`).	Yes
`documentType`	string	The type of the recipient's document (e.g., `"NationalId"`).	Yes
`documentNumber`	string	The document number of the recipient (e.g., `"123456"`).	Yes

`transfer` (Object) - Required

Field Name	Field Type	Field Description	Required
`type`	string	The transfer type (e.g., `"MobileWallet"`).	Yes
`amount`	string	The transfer amount.	Yes
`currencyCode`	string	The currency code for the transfer (e.g., `"KES"`).	Yes
`date`	string	The date of the transfer (format: `YYYY-MM-DD`).	Yes
`description`	string	A description of the transfer.	No

Example Request

curl --request POST \
     --url https://uat.finserve.africa/v3-apis/transaction-api/v3.0/remittance/sendmobile/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",
                "mobileNumber": "0763123456",
                "walletName": "Mpesa",
                "documentType": "NationalId",
                "documentNumber": "123456"
            },
            "transfer": {
                "type": "MobileWallet",
                "amount": "1000",
                "currencyCode": "KES",
                "date": "2018-08-18",
                "description": "some remarks here",
            }
        }
        '

Example Response

{
    "status": true,
    "code": 0,
    "message": "success",
    "data": {
      "transactionId": "",
      "status": "SUCCESS"
    }
}

Within Equity Bank Pesalink - Bank Account