Billpay Transaction
This API is used by businesses or individual users to initiate transactions from a mobile or web application.
Endpoint
Method: POST
URL: {{URL}}/rpc/paymentv2
Headers
Key | Type | Required | Description |
---|---|---|---|
Content-Type | string | Yes | application/json |
Request
{
"method": "billpay.transfer",
"id": "1",
"params": {
"payload": {
"channel": "MASTER_CARD",
"source": "RPPS",
"transactionType": "BILLPAY",
"Product": "MASTER",
"Program": "MASTER",
"reference": "REFBILLPAY00001202403071517",
"transactionDateTime": "2025-03-14 15:08:23",
"reason": "Athletic Monthly Bill settlement",
"transactionAmount": {
"amount": "800",
"currency": "USD"
},
"debtorAccount": {
"identification": "200072372589881",
"identificationType": "ACCOUNT_NUMBER"
},
"creditor": {
"userType": "BILLER",
"firstName": "Athletic & Swim Club",
"billerId": "1831401311",
"billerName": "AMHERST ALARM",
"billerType": "Core",
"identification": "12334",
"identificationType": "ACCOUNT_NUMBER"
}
},
"api": {
"credential": "Basic bS5rdW1hcis5MTNAbmV0eGQuY29tOlRlc3RAMTIzNA==",
"signature": "MEUCIEIL1PLI1j5IvZjPqa+5cgWkohSaRMPgtY/4RIJGMf/BAiEA47SUNIEzKSIlfgT3/ShMw6eM+AOg2HNDt61vjx8hQ/s=",
"apiKey": "21940d11f5d84c0a953e9433fcd2ccc6"
}
}
}
Response: 200
Response Parameters
Parameter | Description |
---|---|
method Mandatory | String API name Constant : billpay.transfer |
id Mandatory | String Unique ID for Request |
channel Mandatory | String Transaction channel Constant : MASTER_CARD |
source Optional | String Source of transaction Example : RPPS |
transactionType Mandatory | String Type of transaction Constant : BILLPAY |
product Optional | String Ledger product name Example : MASTER |
program Optional | String Ledger program name Example : MASTER |
reference Mandatory | String Unique reference ID for transaction |
transactionDateTime Mandatory | String Transaction timestamp (format YYYY-MM-DD-HH-MM-SS) |
reason Optional | String Reason for the transaction |
transactionAmount. amount Mandatory | String Transaction amount |
transactionAmount. currency Mandatory | String Currency of transaction |
debtorAccount. identification Mandatory | String Debtor account number |
debtorAccount. identificationType Mandatory | String Identification type Constant : ACCOUNT_NUMBER |
creditor. userType Mandatory | String User type Constant : BILLER |
creditor. firstName Mandatory | String Creditor first name |
creditor. billerId Mandatory | String Creditor biller ID |
creditor. billerName Mandatory | String Creditor biller name |
creditor. billerType Mandatory | String Creditor biller type |
creditor. identification Mandatory | String Consumer number |
creditor. identificationType Mandatory | String Identification type Constant : ACCOUNT_NUMBER |
credential Mandatory | String API credential for authentication |
signature Mandatory | String Signature for request validation |
apiKey Mandatory | String API key for authentication |
{
"id": "1",
"error": {
"code": "2053",
"message": "INVALID_ACCOUNT_NUMBER",
"data": {
"type": "BILLPAY_ACK",
"reference": "REFBILLPAY00001202403071517",
"dateTime": "2025-03-14 17:32:32",
"originalReference": "REFBILLPAY00001202403071517",
"originalRequestBase64": "eyJjaGFubmVsIjoiTUFTVEVSX0NBUkQiLCJ0cmFuc2FjdGlvblR5cGUiOiJCSUxMUEFZIiwicHJvZHVjdCI6Ik1BU1RFUiIsInByb2dyYW0iOiJNQVNURVIiLCJ0cmFuc2FjdGlvbkRhdGVUaW1lIjoiMjAyNS0wMy0xNCAxNTowODoyMyIsInJlZmVyZW5jZSI6IlJFRkJJTExQQVkwMDAwMTIwMjQwMzA3MTUxNyIsInJlYXNvbiI6IkF0aGxldGljIE1vbnRobHkgQmlsbCBzZXR0bGVtZW50IiwidHJhbnNhY3Rpb25BbW91bnQiOnsiYW1vdW50IjoiODAwIiwiY3VycmVuY3kiOiJVU0QifSwiZGVidG9yQWNjb3VudCI6eyJpZGVudGlmaWNhdGlvbiI6IjIwMDA3MjM3MjU4OTg4MSIsImlkZW50aWZpY2F0aW9uVHlwZSI6IkFDQ09VTlRfTlVNQkVSIn0sImNyZWRpdG9yIjp7InVzZXJUeXBlIjoiQklMTEVSIiwiaWRlbnRpZmljYXRpb24iOiIxMjMzNCIsImlkZW50aWZpY2F0aW9uVHlwZSI6IkFDQ09VTlRfTlVNQkVSIiwiZmlyc3ROYW1lIjoiQXRobGV0aWMgXHUwMDI2IFN3aW0gQ2x1YiIsImJpbGxlcklkIjoiMTgzMTQwMTMxMSIsImJpbGxlck5hbWUiOiJBTUhFUlNUIEFMQVJNIiwiYmlsbGVyVHlwZSI6IkNvcmUifX0="
}
},
"header": {
"reference": "REFBILLPAY00001202403071517",
"apiKey": "21940d11f5d84c0a953e9433fcd2ccc6",
"signature": "MEUCIEIL1PLI1j5IvZjPqa+5cgWkohSaRMPgtY/4RIJGMf/BAiEA47SUNIEzKSIlfgT3/ShMw6eM+AOg2HNDt61vjx8hQ/s="
}
}