Bill Payment API
API for paying a Customer Bill, based on Biller Category, Customer Parameters etc.
Request:POST /couapp/agent/bills/payment
Request Parameters
The various parameters are explained below:
[ROOT] (No parent property / element)
tenantId
M
Alphanumeric
Fixed Length – 4
refId
M
Alphanumeric
35-character Alphanumeric ID Unique to each transaction.
billId
M
Alphanumeric
Generated when a bill fetch or bill validation is initiated
amountBreakSet
C
List
paymentMode
M
String
paymentInformation
M
String
amountOptions
M
Boolean
billerId
M
Alphanumeric
Unique ID assigned to the Biller by NPCI Eg: BSNL00000NATHL
billerName
M
String
Name of the biller
billerCategory
M
String
Category of biler
macAdress
C
Alphanumeric
MAC Address of the Agent Server
customerMobNo
M
String
Mobile of the Customer, on whose behalf the Agent is paying the Bill
txnAmount
M
Int
Transaction amount
paymentChannel
M
String
Payment Channel of Agent
deviceBlockTags
M
List
Device block tags of Agent
customerParamsReques t
M
Object
Unique parameters used for identifying a Customer Bill
customerParamsReq uest
tags
M
List
List of customer params
tags
name
M
String
Name of customer param
tags
value
M
String
Value of customer param
Response Parameters
The various parameters are explained below:
[ROOT](No parent property / element)
billid
C
UUID
Machine-generated Unique ID for a Bill, used internally
refId
C
String
Will be null
billerId
C
String
Will be null
status
C
String
Will be null
actionType
C
String
Will be null
billerResponse
C
String
Will be null
additionalInfo
C
String
Will be null
customerParams
C
String
Will be null
creationDate
C
String
Will be null
modifiedDate
C
String
Will be null
createdEpochDate
C
String
Will be null
modifiedEpochDate
C
String
Will be null
generalResp
statusCode
M
Numeric
200- SUCCESS Other than 200-Failure
status
M
String
It is either “Success” or failure
message
M
String
Contains the reason message for failure / success
remarks
C
String
Json Formatted Request Example
Json Formatted Response Example
Initiating Channel Vs Device Block Parameters
Bank Branch
IFSC, MOBILE, GEOCODE, POSTAL_CODE
Mobile (Pre-login)
IP, IMEI, OS, APP
Mobile Banking(Post-login)
IP, IMEI, OS, APP
Internet (Pre-login)
IP, MAC
Internet Banking (Post-login) ATM
IP, MAC
TERMINAL_ID
Kiosk
TERMINAL_ID
Agent
TERMINAL_ID, MOBILE, GEOCODE, POSTAL_CODE
Business Correspondent
TERMINAL_ID, MOBILE, GEOCODE, POSTAL_CODE
Payment Mode Vs Payment Info Parameters
Cash
Remarks
Internet Banking
IFSC|AccountNo
Credit Card
CardNum|AuthCode
DEbit Card
CardNum|AuthCode
Prepaid Card
CardNum|AuthCode
IMPS
MMID|MobileNo
NEFT
IFSC|AccountNo
UPI
VPA
Wallet
WalletName|MobileNo
AEPS
Aadhaar|IIN
Account Transfer
IFSC|AccountNo
Bharat QR
IFSC|AccountNo
USSD
Remarks
Last updated