Overview
Api to get fetched bill
GET /bbps/fetched-bills
Description
Api to get fetched bill
Responses
Status: 200 - List of fetched bills
{ []
Required: success,traceId
data: ▼ { []
Required: bills
bills: ▼ [ []
▼ { []
Required: refId,status
status: string
Enum: Processing , Success , Failure
example: Success
additionalInfo: ▼ [ []
▼ { []
Required: name,value
name: string
example: Line item 1
value: string
example: Value 1
}
]
exactness: string
example: EXACT/EXACT_UP/EXACT_DOWN/ADHOC
isCached: ▼ [] boolean
Denotes the bill fetch's cache status
refId: ▼ [] string
BBPS Reference ID
example: HENSVVR4QOS7X1UGPY7JGUV444P10102202
lastPaidDate: string (date-time)
example: 2020-12-12T07:42:00Z
autoFetchHash: string
example: d28ca210e0267a13fa0db18ee96a349dc4578f032e5902192af762763224204a
bill: ▼ [ []
▼ { []
Required: amount,billDate,billNumber,billPeriod,customerName,dueDate
dueDate: string (date)
amount: integer
billDate: string (date)
billNumber: string
example: 1232332
billPeriod: ▼ [] string
Bill period
Enum: ONETIME , DAILY , WEEKLY , BIMONTHLY , MONTHLY ,
QUARTERLY , HALFYEARLY , YEARLY , ASPRESENTED , NA
example: MONTHLY
customerName: string
example: Manoj Chekuri
}
]
billerRefId: string
example: 7f16a032e514
failureReason: ▼ { []
Required: code,message
code: ▼ [] string
BBPS Error code
example: ERR004
message: ▼ [] string
BBPS Failure message
example: customer not found
type: string
Enum: FUND_TRANSFER , BBPS , APP
}
}
]
nextPage: string
example: /api/v1/bbps/fetched-bills?autoFetchHash=xyz&after=ABCC00000PTNNS&limit=5
total: integer
}
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
success: boolean
example: true
traceId: string
example: C3SFG0O6N88R6UI7EQ
}
{ []
Required: success,traceIdzz
data: ▼ { []
Required: bills
bills: ▼ [ []
▼ { []
Required: refId,status
status: string
Enum: Processing , Success , Failure
example: Success
additionalInfo: ▼ [ []
▼ { []
Required: name,value
name: string
example: Line item 1
value: string
example: Value 1
}
]
exactness: string
example: EXACT/EXACT_UP/EXACT_DOWN/ADHOC
isCached: ▼ [] boolean
Denotes the bill fetch's cache status
refId: ▼ [] string
BBPS Reference ID
example: HENSVVR4QOS7X1UGPY7JGUV444P10102202
lastPaidDate: string (date-time)
example: 2020-12-12T07:42:00Z
autoFetchHash: string
example: d28ca210e0267a13fa0db18ee96a349dc4578f032e5902192af762763224204a
bill: ▼ [ []
▼ { []
Required: amount,billDate,billNumber,billPeriod,customerName,dueDate
dueDate: string (date)
amount: integer
billDate: string (date)
billNumber: string
example: 1232332
billPeriod: ▼ [] string
Bill period
Enum: ONETIME , DAILY , WEEKLY , BIMONTHLY , MONTHLY ,
QUARTERLY , HALFYEARLY , YEARLY , ASPRESENTED , NA
example: MONTHLY
customerName: string
example: Manoj Chekuri
}
]
billerRefId: string
example: 7f16a032e514
failureReason: ▼ { []
Required: code,message
code: ▼ [] string
BBPS Error code
example: ERR004
message: ▼ [] string
BBPS Failure message
example: customer not found
type: string
Enum: FUND_TRANSFER , BBPS , APP
}
}
]
nextPage: string
example: /api/v1/bbps/fetched-bills?autoFetchHash=xyz&after=ABCC00000PTNNS&limit=5
total: integer
}
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
success: boolean
example: true
traceId: string
example: C3SFG0O6N88R6UI7EQ
}
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
}
{ []
Required: success,traceId
data: ▼ { []xxx
Required: bills
bills: ▼ [ []
▼ { []
Required: refId,status
status: string
Enum: Processing , Success , Failure
example: Success
additionalInfo: ▼ [ []
▼ { []
Required: name,value
name: string
example: Line item 1
value: string
example: Value 1
}
]
exactness: string
example: EXACT/EXACT_UP/EXACT_DOWN/ADHOC
isCached: ▼ [] boolean
Denotes the bill fetch's cache status
refId: ▼ [] string
BBPS Reference ID
example: HENSVVR4QOS7X1UGPY7JGUV444P10102202
lastPaidDate: string (date-time)
example: 2020-12-12T07:42:00Z
autoFetchHash: string
example: d28ca210e0267a13fa0db18ee96a349dc4578f032e5902192af762763224204a
bill: ▼ [ []
▼ { []
Required: amount,billDate,billNumber,billPeriod,customerName,dueDate
dueDate: string (date)
amount: integer
billDate: string (date)
billNumber: string
example: 1232332
billPeriod: ▼ [] string
Bill period
Enum: ONETIME , DAILY , WEEKLY , BIMONTHLY , MONTHLY ,
QUARTERLY , HALFYEARLY , YEARLY , ASPRESENTED , NA
example: MONTHLY
customerName: string
example: Manoj Chekuri
}
]
billerRefId: string
example: 7f16a032e514
failureReason: ▼ { []
Required: code,message
code: ▼ [] string
BBPS Error code
example: ERR004
message: ▼ [] string
BBPS Failure message
example: customer not found
type: string
Enum: FUND_TRANSFER , BBPS , APP
}
}
]
nextPage: string
example: /api/v1/bbps/fetched-bills?autoFetchHash=xyz&after=ABCC00000PTNNS&limit=5
total: integer
}
error: ▼ { []
Required: code,message
message: string
example: Input is invalid
code: string
example: validation-error
}
success: boolean
example: true
traceId: string
example: C3SFG0O6N88R6UI7EQ
}
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
Query parameters
autoFetchHash
array[String]
Autofetch hash if present
Query parameters
limit
Integer
Limit
Query parameters
after
String
Usage and SDK Samples
CURL
curl -X GET\
\
-H "Accept: application/json"\
"/api/v1/bbps/fetched-bills?autoFetchHash=&limit=&after="
Axis Aha!