search
Your Paytm for business app is working and will keep working beyond March 15th, 2024. Click to know more

GETFetch Bulk Bin List API

Use Case

This API can fetch BIN list for the following specific features powered by Paytm PG:

  • Complete BIN list having Native OTP (IVR) support.
  • Complete BIN list having EMI eligibility support.

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestId
string
mandatory

Unique reference ID for a transaction which is generated by merchant and sent in the request

clientId
string
mandatory

Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

signature
string
mandatory

Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

{
  "mid": "your_mid",
  "requestid": "<UUID>",
  "attribute": "isEmiEligible"
}
signatureType
string
mandatory

CHECKSUM

Query Params

ATTRIBUTE DESCRIPTION
from string 
optional
The ISO Date to identify the bins that were updated from this date. If not provided, all the bins that match the attribute and value will be returned in paginated format.
Example: 2023-10-01T00:00:00.000Z
to string
optional
The ISO Date to identify the bins that were updated till this date. The date given here should be not less than 45 days and not greater than the current date.
Example: 2023-10-05T00:00:00.000Z
attribute string
mandatory
The attribute for which the bulk Bin data is required. 
Possible Value: isEmiEligible, isNativeOtpEligible
value string
optional
The value of the attribute to be matched.
Possible Value: true
page string
optional
The page number if there are multiple pages.
Possible Value: true

Response Attributes

Content Type : JSON

Head

AttributeDescription
requestid
string

Unique reference ID for a transaction which is generated by merchant and sent in the request

Body

AttributeDescription
resultInfo
object

This parameter gives the information about the result of the API response

resultInfo
+
AttributeDescription
resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.

resultMsg
string

This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below.
 

resultStatus
string
This parameter indicates the status of API call. Possible Values:
S,
For Success
F,
For Failure
U
For Unknown
metadata
string
metadata
+
AttributeDescription
from
string

The from  value sent in the request.

2023-10-01T00:00:00Z

to
string

The to value sent in the request.

2023-10-05T00:00:00Z

attribute
string

The attribute value sent in the request

isEmiEligible,isNativeOtpEligible

value
string

The optional value matcher sent in the request

true

page
string

The page value sent in the request

1,2.....

total
string

Total number of pages present in this query.

1,2,3,......

Bins
string

Each instance of the data list will contain the following object.

Bins
+
AttributeDescription
bin
string

The value of the bin that is aggregated.

$attribute
string

The value of the attribute

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
0004SNo Data Available, No Content
0401FUnauthorised access to API
0500FInternal Server Error
Staging
Production
https://securegw-stage.paytm.in/bin-center/v1/bulk/bin/list?page=23&value=true&attribute=isNativeOtpEligiblecopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://secure.paytmpayments.com/bin-center/v1/bulk/bin/list?page=23&value=true&attribute=isNativeOtpEligible' \
--header 'signature: checksum-signature-generated' \
--header 'clientId: your-client-id' \
--header 'requestId: 1617646a-e068-4098-9903-4cb0a54aafab'
copy icon