SchemaPayment FeaturesCards

Look up BIN information

View as Markdown
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).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
cardobjectRequired

Polymorphic object that contains payment details.

The value of the type parameter determines which variant you should use:

  • card - Payment card details
  • cardBin - Bank identification number (BIN) of the payment card
  • secureToken - Secure token details
  • digitalWallet - Digital wallet details
processingTerminalIdstringOptional4-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.

Response

Successful request. Returns the BIN information.
typestring
Card brand of the card, for example, Visa.
cardNumberstring12-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.

countrystringOptionalformat: "iso-3166-1"

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

currencyenumOptional

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

debitbooleanOptional
Indicates if the card is a debit card.
healthcarebooleanOptional

Indicates if the card is linked to a Flexible Spending Account (FSA) or a Health Savings Account (HSA). The value is one of the following:

  • true - Card is linked to an FSA or an HSA.
  • false - Card isn’t linked to an FSA or an HSA.
surchargingobjectOptional
Object that contains surcharge information. Our gateway returns this object only if the merchant adds a surcharge to transactions.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
500
Internal Server Error