Overview
To list paid bills
GET /bbps/transactions
Description
To list paid bills
Responses
Status: 200 - List of Txns
{ []
Required: data,success,traceId
data: ▼ { []
nextPage: string
example: /api/bbps/billers?
search=Aditya&CategoryCode=Loan+Repayment&CategoryCode=
Insurance&after=ABCC00000PTNNS
transactions: ▼ [ []
▼ { []
amount: integer
billerId: ▼ [] string
The biller ID on BBPS
example: MAHI00000NATIC
refId: ▼ [] string
BBPS Reference ID
example: HENSVVR4QOS7X1UGPY7JGUV444P10102202
refundStatus: string
Enum: Required , Requested , Processed
example: Required
status: string
Enum: Processing , Success , Error
example: Success
timestamp: ▼ [] string (date-time)
Timestamp provided by partner while making payment request.
example: 2020-12-12T07:42:00Z
mobile: ▼ [] string minLength:6 maxLength:20
Mobile number with 6, 10 and 20 digits are valid.
Pattern: ^\d{6}(\d{4}(\d{10})?)?$
example: 9481773053
partnerRefId: string
example: AX30910192192192192
transactionId: ▼ [] string
Setu BillPay Transaction ID.
example: AX30910192192192192
}
]
}
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
}
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
limit
Integer
Query parameters
after
String
Query parameters
startDate
date (date)
start date of the timestamp provided by the
partner while making the request.
Full-date notation as defined by RFC 3339,
section 5.6, for example, 2017-07-21
Query parameters
endDate
date (date)
full-date notation as defined by RFC 3339,
section 5.6, for example, 2017-07-21
Query parameters
billerId
String
Transaction BillerId
Query parameters
ids
array[String]
Transaction Reference Ids
Query parameters
categories
array[String]
Biller Category
Query parameters
billerFetchApiType
String
Denotes whether the biller accepts Fetch, Validate or Direct payment.
Query parameters
months
array[date] (date)
Month ranges. A full-date notation as
defined by 'RFC 3339, section 5.6' has to
be provided but only month and year will
be considered.
Query parameters
status
array[String]
Transaction Status
Query parameters
mobile
String
Mobile number with 6, 10 and 20 digits are valid.
Query parameters
expand
array[String]
Query parameters
refundStatus
String
Usage and SDK Samples
CURL
curl -X GET\
\
-H "Accept: application/json"\
"/api/v1/bbps/transactions?limit=&after=&startDate=&endDate=&billerId=&ids=&categories=&billerFetchApiT
ype=&months=&status=&mobile=&expand=&refundStatus="
Axis Aha!