SasaPay Remittance API
SasaPay Remittance API allows SasaPay merchants to do remittance disbursements.
Request Parameters
| Field | Type | Description | Examples |
|---|---|---|---|
| MerchantCode | String | A unique number assigned to an organization/merchant registered with ViewTech, through which payment is received | "2*****8" |
| MerchantTransactionReference | String | A unique reference for the transaction | "TESTVX1239".00 |
| DestinationChannelCode | String | A unique number that identifies the receiving body | "63902" |
| DestinationChannelName | String | The receiving body name | "M-PESA " |
| Currency | String | This is the destination currency code. | KES or TZS |
| Amount | String | This is the destination amount. Amount to be received by the recipient. This will be determined by the Currency provided | "100000" |
| ReceiverPhoneNumber | String | The Phone number of the recipient of the remittance funds | "25****6614677 " |
| ReceiverAccountNumber | String | The Account which the remittance is made to | "25****6614677 " |
| AccountReference | String | This is the reference to of the transaction being made. This field is optional for TILL payments. | "1234" |
| ReceiverAccountType | String | This is the identifier of the receiver merchant code. MUST be PAYBILL or TILL | "PAYBILL" |
| ReceiverAccountName | String | The user receiving the remitted amount | "John Doe" |
| ForeignCurrency | String | This is enabled if the merchant wants the customer to pay via sasapay wallet. | "USD,1 " |
| SenderPhoneNumber | String | The sender phone number | "25477**_104 " |
| SenderName | String | The name of the person remitting money | "John Doe " |
| SenderDOB | String | This is the sender date of birth | "2020-08-08 " |
| SenderCountryISO | String | This is the unique identifier for each country | "GB " |
| SenderNationality | String | The sender's nationality | "British " |
| SenderIDType | String | This is the sender identification | "National ID" |
| SenderIDNumber | String | The SenderIDType Number | "123_**78 " |
| SenderServiceProviderName | String | The platform the sender is using for payments | "SasaPay Remit " |
| RemittancePurpose | String | The reason for payment | "pay for servives " |
| CallbackURL | Url | This is the URL where SasaPay will send the results after the payment process is initiated. | "https://example.com/callbacks " |
| Remarks | String | Description of the transaction being performed | "Test " |
Channel Codes
Channel Codes
CodeEntity Name
- 00 SasaPay
- 01 KCB
- 02 Standard Chartered Bank KE
- 03 Absa Bank
- 07 NCBA
- 10 Prime Bank
- 11 Cooperative Bank
- 12 National Bank
- 14 M-Oriental
- 16 Citibank
- 18 Middle East Bank
- 19 Bank of Africa
- 23 Consolidated Bank
- 25 Credit Bank
- 31 Stanbic Bank
- 35 ABC Bank
- 36 Choice Microfinance Bank
- 43 Eco Bank
- 50 Paramount Universal Bank
- 51 Kingdom Bank
- 53 Guaranty Bank
- 54 Victoria Commercial Bank
- 55 Guardian Bank
- 57 I&M Bank
- 61 HFC Bank
- 63 DTB
- 65 Mayfair Bank
- 66 Sidian Bank
- 68 Equity Bank
- 70 Family Bank
- 72 Gulf African Bank
- 74 First Community Bank
- 75 DIB Bank
- 76 UBA
- 78 KWFT Bank
- 89 Stima Sacco
- 97 Telcom Kenya
- 63902 MPesa
- 63903 AirtelMoney
- 63907 T-Kash
- VODACOM
- AIRTELMONEYTZ
- TIGO
- HALOPESA
- AZAMPESA
Sample post request
Headers
Key: Authorization
Value: Bearer cFJZcjZ6anEwaThMMXp6d1FETUxwWkIzeVBDa2hNc2M6UmYyMkJmWm9nMHFRR2xWOQ==
Body:
{
"MerchantCode":"600980",
"MerchantTransactionReference":"TESTVX1239",
"DestinationChannelCode":"63902",
"DestinationChannelName":"M-PESA", #Tanzania MNOs are supported('VODACOM', 'AIRTELMONEYTZ', 'TIGO', 'HALOPESA', 'AZAMPESA')
"Currency":"KES", # or TZS
"Amount":"150",
"ReceiverPhoneNumber":"25****6614677",
"ReceiverAccountNumber":"25****6614677",
"AccountReference": "Test",
"ReceiverAccountType": "PAYBILL",
"ReceiverAccountName":"Jane Doe",
"ForeignCurrency":"USD,1",
"SenderPhoneNumber":"25477***104",
"SenderName":"John Doe",
"SenderDOB":"2020-08-08", #Optional
"SenderCountryISO":"GB",
"SenderNationality":"British",
"SenderIDType":"National ID",
"SenderIDNumber":"123***78",
"SenderServiceProviderName":"SasaPay Remit",
"RemittancePurpose":"Test",
"CallbackURL":"https://example.com/callbacks",
"Remarks": "Test"
}
Response Sample
| Field | Type | Description | Example |
|---|---|---|---|
| status | Boolean | This is a boolean true or false status that indicates the outcome of the response. true means success and false means transaction failed or intermittent error occured. | true |
| detail | String | A description of the response status sent by SasaPay API. | "Transaction of KSH50 to 2547*677 is being processed" |
| RequestID | String | An identifier for the transaction request returned by SasaPay upon successful request submission. This is generated by SasaPay API. | "4040359-0f8****1-4779-85b3-44e575166f7a" |
| ResponseCode | String | This is a numeric status code that indicates the status of the response. 0 means success and any other code means an error occurred or the request failed. | 0 |
| CheckoutRequestID | String | A unique identifier of the transaction request | "763df0f8-a815-40f5-b13f-cdb4632793e6" |
| TransactionCharges | String | This is the charges for the transaction. | "Transaction of KSH50 to 2547*677 is being processed." |
Sample response
{
"status": true,
"detail": "Transaction is being processed",
"ResponseCode": "0",
"RequestID": "2612-333c5306-****-43e4-8edb-1c63372ed886",
"MerchantRequestID": "128338358",
"TransactionCharges": "0.00"
}
Results Response
| Field | Type | Description | Example |
|---|---|---|---|
| MerchantCode | String | A unique number assigned to an organization/merchant registered with ViewTech, through which payment is received (can be Paybill or Till number) | “2*****8” |
| DestinationChannel | String | This name of entity channel where the funds are sent. | "MPESA" |
| RecipientName | String | This full name of the customer receiving the funds. | "John Kym Doe" |
| RecipientAccountNumber | String | This account number where the funds are received | "2547*******7" |
| ResultCode | String | The numeric status of the results, sent to the callback url | 0 means success, while any other code indicates that an error occurred. The specific error is describe in the ResultDesc field |
| ResultDesc | String | This is a message from the API that gives the status of the request processing and usually maps to a specific result code value. | "Transaction processed successfully." |
| SourceChannel | String | The name of the entity channel from where the funds transfer is initiated | "SasaPay" |
| SasaPayTransactionCode | String | This is the transaction code from SasaPay | "CRVSUVGIRP" |
| CheckoutRequestID | String | This is a unique SasaPay transaction ID for every payment request. Same value is sent to the customer over SMS upon successful processing. | "6f3ebd0d-b892-4c4e-952a-f3eea030af85" |
| SasaPayTransactionID | String | This is a unique SasaPay transaction ID for every payment request. Same value is sent to the customer over SMS upon successful processing. It is usually returned under the ResultParameter array. | PR52 |
| ThirdPartyTransactionCode | String | This is a unique ThirdParty transaction reference for a B2C transaction. | "SQ33424" |
| TransactionAmount | String | This is the amount that was transacted. It is usually returned under the ResultParameter array. | "10.00" |
| TransactionCharges | String | This is the amount of money the merchant is charged for the transaction. | 0 |
| MerchantRequestID | String | The unique id sent with the transaction request from the Merchant system | "25*******77" |
| MerchantTransactionReference | String | A unique identifier of the transaction generated by the Merchant system. | "254******77" |
| TransactionDate | String | This is the date and time that the transaction completed SasaPay. | "20220305103101" |
| MerchantAccountBalance | String | This is the available balance of the Charges Paid account under the B2C MerchantCode used in the transaction. | 564.00 |
sample result response
{
"MerchantCode": "6***0",
"DestinationChannel": "MPESA",
"RecipientName": "Johh Kym Doe",
"RecipientAccountNumber": "2547*******7",
"ResultCode": "0",
"CheckoutRequestID": "6f3ebd0d-b892-4c4e-952a-f3eea030af85",
"MerchantRequestID": "25*******77",
"ResultDesc": "Transaction processed successfully.",
"SourceChannel": "SasaPay",
"SasaPayTransactionCode": "CRVSUVGIRP",
"LinkedTransactionCode": "SWEHMIM3INM",
"TransactionDate": "20220305103101",
"TransactionAmount": "10.00",
"TransactionCharge": "0.00",
"SasaPayTransactionID": "PR52",
"ThirdPartyTransactionCode": "SG83YAAGSF",
"MerchantTransactionReference": "254******77",
"MerchantAccountBalance": "564.00"
}