Get billers

1.0.0

Online

Overview

Api to list billers in category

GET /bbps/billers
Description

Api to list billers in category

Responses
Status: 200 - List of billers
{ []
Required: success,traceId
data: ▼ { []
Required: billers
nextPage: string
example: /api/bbps/billers?search=Aditya&CategoryCode=
Loan+Repayment&CategoryCode=
Insurance&after=ABCC00000PTNNS
total: integer
billers: ▼ [ []
▼ { []
Required:
categoryName,customerParams,exactness,
fetchApiType,id,name,payWithoutFetchAllowed,
paymentChannels,paymentModes,customerParamsGroups: ▼ [ []
▼ [ []
string
example: Param 1
]
]
exactness: string
Enum: Exact , Exact and above , Exact and below
fetchApiType: ▼ [] string
Denotes whether the biller accepts Fetch, Validate or Direct payment.
Enum: BILL_FETCH , BILL_VALIDATE , BILL_DIRECT
example: BILL_FETCH
logo: string
example: logo
payWithoutFetchAllowed: boolean
example: true
state: string
example: state
city: string
example: city
customerParams: ▼ [ []
▼ { []
Required: dataType,maxLength,minLength,optional,
paramName,regex,values,visibility
maxLength: integer
minLength: integer
optional: boolean
paramName: string
example: Loan Account Number
regex: string
example: ^[a-zA-Z0-9]{7,15}
values: string
visibility: boolean
example: true
dataType: string
example: ALPHANUMERIC
}
]
pincode: string
example: pincode
categoryName: string
example: loan-repayment
id: string
example: ADIT00000NAT0T
modifiedAt: string (date-time)
example: 2021-11-12T08:07:04.572Z
name: string
example: Aditya Birla Sun Life Insurance
paymentChannels: ▼ [ []
▼ { []
Required: maxLimit,minLimit,paymentChannel,supportsPendingStatus
supportsPendingStatus: boolean
maxLimit: integer
minLimit: integer
paymentChannel: ▼ [] string
Schema
This is the initiating channel.
1. AGT : Offline agent.
2. BNKBRNCH : Bank branch.
3. BSC : Business correspondent
4. MOB : Mobile application
5. INT : Internet portal
6. INTB : Internet banking
7. MOBB : Mobile banking
8. ATM : ATM
9. KIOSK : KIOSK
Enum: INT , INTB , MOB , BNKBRNCH , BSC , AGT
MPOS
example: INT
}
]
createdAt: string (date-time)
example: 2021-11-12T08:07:04.572Z
paymentModes: ▼ [ []
▼ { []
Required: maxLimit,minLimit,paymentMode,supportsPendingStatus
maxLimit: integer
minLimit: integer
paymentMode: string
Enum: Internet Banking , Debit Card , Credit Card
UPI , Wallet , NEFT , AEPS , Account Transfer ,
example: Internet Banking
supportsPendingStatus: boolean
}
]
subCategoryName: string
example: DAIRY
supportsPendingStatus: boolean
tags: string
example: tags
coverage: string
example: IND
}
]
}
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
}
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

categoryName

array[String]
Category of the biller
Query parameters

ids

array[String]
Billers to search
Query parameters

limit

Integer
Limit
Query parameters

after

String
Billers are sorted via the Biller ID. Providing a biller Id fetches billers right after this biller in a paginated way.
Query parameters

search

String
Searches the provided text over Biller name and Biller Alias
Query parameters

pincode

String
Query parameters

state

String
Query parameters

city

String
Query parameters

tags

String
Query parameters

paymentChannel

array[String]
Query parameters

paymentMode

array[String]
Usage and SDK Samples
CURL
curl -X GET\
\
-H "Accept: application/json"\
"/api/v1/bbps/billers?categoryName=&ids=&limit=&after=&search=&pincode=&state=&city=&tags=&paymentChann
el=&paymentMode="
Axis Aha!