search

POSTFetch BIN API

Use Case

To check if the BIN entered by the user is a valid card BIN from which AI router can process a payment.To check if subscription payments are available on the BIN also to get the card details like card scheme and issuing bank of the BIN.

 

 Note

  • TxnToken URL (Mentioned as endpoints under the top-right section of this document)
  • AccessToken URL:
    • Staging URL
      • https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchBinDetail?mid={{mid}}&referenceId={{referenceId}}
    • Prod URL
      • https://router.paytm.in/aoa-pay-option-service/v2/fetchBinDetail?mid={{mid}}&referenceId={{referenceId}}

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimestamp
string
optional

Request time in mili-seconds.

 

Example: 1588402269

token
string
mandatory

This is the unique transaction token

 

Example: ede0b9a1-e30d-4fa0-89fb-68221c3e9ff6

tokenType
TokenType
mandatory

Token Type, Values that can be selected: TXN_TOKEN, ACCESS

channelId
EchannelId
mandatory

The parameter value identifies the Channel for which API call is initiated.

 

Possible values: WEB , WAP

Body

AttributeDescription
bin
string
mandatory

Starting 9 digits of credit or debit card number

mid
string
mandatory

Paytm provides MID as a unique identifier to each merchant

txntype
string
conditional

This parameter is used to identify the payment flow. (Mandatory in case of ADDNPAY)
Possible values: NONE, ADDNPAY
 

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

EPOCH timestamp of the time at which response is being sent.

Body

AttributeDescription
resultInfo
ResultInfo

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

binDetail
BinData

BIN details like issuing bank name and card scheme (Visa/Master..) are provided here

BinData
+
AttributeDescription
bin
string

Bank Identification Number
 

Example: 411111

issuingBank
string

issuing Bank
 

Example: ICICI Bank

issuingBankCode
string

Bank Code
 

Example: ICICI

paymentMode
string

The payment mode used by customer for transaction. If it is 'EMI', we check for EMI details for a particular emiType and channelCode only.
 

Example: CREDIT_CARD

channelName
string

Name of card scheme of the BIN
 

Example: VISA

channelCode
string

Code of card scheme of the BIN
 

Example: VISA

cnMin
string

Minimum card number digits
 

Example: 13

cnMax
string

Maximum card number digits
 

Example: 19

cvvR
boolean

CVV required or not
 

Possible Values: true, false

cvvL
string

CVV length
 

Example: 3

expR
boolean

Expiry required or not
Possible Values: true, false

isActive
boolean

BIN status
Possible Values: true, false

isIndian
boolean

Whether card is Indian or not
Possible Values: true, false

binTokenization
boolean

True if a particular bin is eligible for coft, false otherwise.

isEligibleForCoft
boolean

True if particular scheme is eligible for coft, false otherwise
Possible Values: true, false

isCoftPaymentSupported
string

Status whether bin supports token payment or not.

cardPrefix
string

Prefix of card

countryCode
string

The ISO 2-letter country code of the issuer.  
Example: IN

countryName
string

The full country name of the issuer.
Example: India

countryNumericCode
string

The ISO 3-letter country code of the issuer.
Example: 356

currencyCode
string

The ISO 4217 currency code associated with the country of the issuer.
Example: INR

currencyName
string

The full currency name associated with the country of the issuer.
Example: Rupee

currencyNumericCode
string

The ISO 3166 currency code associated with the country of the issuer.  
Example: 356

currencySymbol
string

The symbol of the currency associated with the country of the issuer.
Example:

authModes
List<String>

Auth mode available on the BIN

 

Possible Value: OTP

iconUrl
string

Icon URL of issuing bank of saved card

isEmiAvailable
boolean

Depicts, if the EMI is available on the selected BIN or not

isSubscriptionAvailable
boolean

Depicts if subscription payments are available on this BIN or not.
In case the value is true, then subscription payments are supported.
 

Response Codes & Messages

resultCoderesultStatusresultMsg
0000SSuccess
1003FBin number is not valid
1001FRequest parameters are not valid Note: If the value is not valid in the request parameter then the result message should be in the format of "Invalid {field name}" For example:Invalid tokenType, etc
1007FMissing mandatory element
501FSystem Error
2014FReferenceId in the query param doesn't match with the ReferenceId send in the request
1006FYour Session has expired
2013FMid in the query param doesn't match with the Mid send in the request
2014FOrderId in the query param doesn't match with the OrderId send in the request
2006FMid is invalid
2006FReference Id is invalid
2222FInvalid request body
1011FParameter illegal Note: If the value is not allowed in request parameters then the result message should be in the format of "Invalid {field name}" For example:Invalid tokenType, etc
Staging
Production
https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchBinDetail?mid={{mid}}&orderId={{orderId}}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://stage-router.paytm.in/aoa-pay-option-service/v2/fetchBinDetail?mid={{mid}}&orderId={{orderId}}' \
--header 'Content-Type: application/json' \
--data '{"head": {"channelId":"WEB","token": "a7bc0582-bbe2-4f63-893c-ea89efbc4b07","tokenType":"TXN_TOKEN"},"body": {"mid":"{{mid}}","bin":"411111"}}'

 

copy icon