Overview
This API initiates a bill fetch request through NPCI to BOU(Biller) and gets a response from the BOU of the concerned biller
POST /bbps/bills/fetch/request
Description
This API initiates a bill fetch request through NPCI to BOU(Biller) and gets a response from the BOU of the concerned biller
Responses
Status: 200 - OK
{ []
Required: data,success,traceId
data: ▼ { []
Required: refId
refId: string
example: HENSVVR4QOS7X1UGPY7JGUV444P10102202
}
success: boolean
example: true
traceId: string
example: HENSVVR4QOS7X1UGPY7JGUV444P10461713
}
{
"GetAccountBalanceRequest": {
"SubHeader": {
"requestUUID": "ABC123",
"serviceRequestId": "OpenAPI",
"serviceRequestVersion": "1.0",
"channelId": "TXBAPI"
},
"GetAccountBalanceRequestBody": {
"channelId": "TXBAPI",
"corpCode": "DEMOTEST1",
"corpAccNum": "********9499978",
"checksum": "sahogoftuf"
}
}
}
Status: 400 - Bad request
{ []
Required: error,success,traceId
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
success: boolean
traceId: string
example: C3SFG0O6N88R6UI7EQ
}{
"GetAccountBalanceRequest": {
"SubHeader": {
"requestUUID": "ABC123",
"serviceRequestId": "OpenAPI",
"serviceRequestVersion": "1.0",
"channelId": "TXBAPI"
},
"GetAccountBalanceRequestBody": {
"channelId": "TXBAPI",
"corpCode": "DEMOTEST1",
"corpAccNum": "********9499978",
"checksum": "sahogoftuf"
}
}
}
Status: 500 - Bad request
{ []
Required: error,success,traceId
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
success: boolean
traceId: string
example: C3SFG0O6N88R6UI7EQ
}Parameters
Header parameters
X-PARTNER-ID*
Integer
Partner ID
Required
Body parameters
body *
{ []
Required: agent,biller,customer
agent: ▼ { []
Required: channel,id
terminalId: [] string
example: 6000011234
geocode: [] string
example: 19.0139,72.8254
imei: [] string
example: 123456789012345
mac: [] string
example: 48-4D-7E-CB-DB-6F
os: [] string
example: iOS
ip: [] string
example: 124.170.23.24
mobile: [] string
example: 9481773053
postalCode: [] string
example: 600001
app: [] string
example: SmartPay
channel: [] string
example: INT
id: [] string
example: AX01AI06512391457204
ifsc: [] string
example: ICIC0000152
}
autoFetch: ▼ [] boolean
When true , enables autofetch on successful bill.
example: true
biller: ▼ { []
Required: id
id: [] string
example: MAHI00000NATIC
}
customer: ▼ { []
Required: billParameters,mobile
billParameters: [] []
mobile: [] string
example: 9481773053
}
forceFetch: ▼ [] boolean
Make a force fetch request.
example: true
}Usage and SDK Samples
CURL
curl -X POST\
\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/api/v1/bbps/bills/fetch/request"
Axis Aha!