Look up BIN information

Use this method to retrieve information about a debit card, a credit card, or an EBT card. If you apply surcharges to transactions, you can also check if the card supports surcharging.

In the response, our gateway returns the following information about the card:

Card details - Information about the card, for example, the issuing bank and the masked card number.
Surcharging information - If you apply a surcharge to transactions, our gateway checks that the card supports surcharging and returns information about the surcharge. For more information about surcharging, go to Credit card surcharging.

Use this method to retrieve information about a debit card, a credit card, or an EBT card. If you apply surcharges to transactions, you can also check if the card supports surcharging. In the response, our gateway returns the following information about the card: - **Card details** - Information about the card, for example, the issuing bank and the masked card number. - **Surcharging information** - If you apply a surcharge to transactions, our gateway checks that the card supports surcharging and returns information about the surcharge. For more information about surcharging, go to [Credit card surcharging](https://docs.payroc.com/knowledge/card-payments/credit-card-surcharging).

Request

This endpoint expects an object.

cardobjectRequired

Object that contains information about the card.

processingTerminalIdstringOptional>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

amountlongOptional

Transaction amount that you send to check the surcharge amount. The value is in the currency's lowest denomination, for example, cents.

currencyenumOptional

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.

Response

Successful request. Returns the BIN information.

typestring

Card brand of the card, for example, Visa.

cardNumberstring>=12 characters<=19 characters

Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, 548010******5929.

countrystring or nullformat: "iso-3166-1"

Country of the issuing bank. The value for the country follows the ISO-3166-1 standard.

Country of the issuing bank. The value for the country follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard.

currencyenum or null

Currency of the transaction. The value for the currency follows the ISO 4217 standard.

Currency of the transaction. The value for the currency follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard.

debitboolean or null

Indicates if the card is a debit card.

surchargingobject or null

Object that contains surcharge information. Our gateway returns this object only if the merchant adds a surcharge to transactions.

1	import requests
2
3	url = "https://api.payroc.com/v1/cards/bin-lookup"
4
5	headers = {
6	"Authorization": "Bearer <token>",
7	"Content-Type": "application/json"
8	}
9
10	response = requests.post(url, headers=headers)
11
12	print(response.json())

1	{
2	"type": "MASTERCARD",
3	"cardNumber": "453985******7062",
4	"country": "US",
5	"currency": "USD",
6	"debit": false
7	}

Headers

Request

Response

Errors