CyberSource Bin Lookup API
The Bin Lookup API from CyberSource — 1 operation(s) for bin lookup.
OpenAPI Specification
swagger: '2.0'
info:
description: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
version: 0.0.1
title: CyberSource Merged Spec bankAccountValidation Bin Lookup API
host: apitest.cybersource.com
basePath: /
schemes:
- https
consumes:
- application/json;charset=utf-8
produces:
- application/hal+json;charset=utf-8
tags:
- name: Bin Lookup
paths:
/bin/v1/binlookup:
post:
summary: BIN Lookup API
description: 'The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources.
This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks (such as Visa, American Express, Discover and several regional networks) which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS).
Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant.
'
tags:
- Bin Lookup
operationId: getAccountInfo
x-devcenter-metaData:
categoryTag: Bin_Lookup
developerGuides: https://developer.cybersource.com/docs/cybs/en-us/bin-lookup/developer/all/rest/bin-lookup/bin-lookup-intro.html
firstLevelApiLifeCycle: beta
secondLevelApiLifeCycle: beta
apiLifeCycle: beta
disableProcessorDropDown: true
SDK_ONLY_AddDisclaimer: true
consumes:
- application/json;charset=utf-8
produces:
- application/json;charset=utf-8
parameters:
- name: createBinLookupRequest
in: body
required: true
schema:
type: object
properties:
clientReferenceInformation:
type: object
properties:
partner:
type: object
properties:
developerId:
type: string
maxLength: 8
description: 'Identifier for the developer that helped integrate a partner solution to CyberSource.
Send this value in all requests that are sent through the partner solutions built by that developer.
CyberSource assigns the ID to the developer.
**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.
'
solutionId:
type: string
maxLength: 8
description: 'Identifier for the partner that is integrated to CyberSource.
Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.
**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.
'
applicationName:
type: string
description: 'The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.
'
applicationVersion:
type: string
description: 'Version of the CyberSource application or integration used for a transaction.
'
applicationUser:
type: string
description: 'The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.
'
paymentInformation:
type: object
properties:
card:
type: object
properties:
number:
type: string
maxLength: 20
description: 'The customer''s payment card number, also known as the Primary Account Number (PAN). You can also use this field
for encoded account numbers.
#### FDMS Nashville
Required. String (19)
#### GPX
Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured
for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine
whether a field is required for the transaction you are requesting.
#### All other processors
Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured
for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine
whether a field is required for the transaction you are requesting.
'
customer:
type: object
properties:
id:
type: string
description: 'Unique identifier for the Customer token used in the transaction.
When you include this value in your request, many of the fields that are normally required for an authorization or credit
become optional.
'
minLength: 1
maxLength: 32
paymentInstrument:
type: object
properties:
id:
type: string
description: 'Unique identifier for the Payment Instrument token used in the transaction.
When you include this value in your request, many of the fields that are normally required for an authorization or credit
become optional.
'
minLength: 1
maxLength: 32
instrumentIdentifier:
type: object
properties:
id:
type: string
description: 'Unique identifier for the Instrument Identifier token used in the transaction.
When you include this value in your request, many of the fields that can be supplied for an authorization or credit
become optional.
'
minLength: 12
maxLength: 32
tokenInformation:
type: object
properties:
jti:
type: string
maxLength: 64
description: 'TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV).
'
transientTokenJwt:
type: string
description: 'Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result.
'
processingInformation:
type: object
properties:
binSource:
type: string
description: 'Bin Source File Identifier.
Possible values:
- itmx
- rupay
'
payoutOptions:
type: object
description: 'Payout fields request parameters
'
properties:
payoutInquiry:
type: boolean
description: 'If `true` then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup.
Possible values:
- true
- false
'
networkId:
type: string
description: "The networks specified in this field must be a subset of the information provided during program enrollment\n \nPossible values:\n- 0020 : Accel/Exchange\n- 0024 : CU24\n- 0003 : Interlink\n- 0016 : Maestro\n- 0018 : NYCE\n- 0027 : NYCE\n- 0009 : Pulse\n- 0017 : Pulse\n- 0019 : Pulse\n- 0008 : Star\n- 0010 : Star\n- 0011 : Star\n- 0012 : Star\n- 0015 : Star\n- 0002 : Visa/PLUS\n"
acquirerBin:
type: string
description: 'BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment.
'
responses:
'201':
description: Successful response.
schema:
type: object
properties:
id:
type: string
maxLength: 26
description: 'An unique identification number generated by Cybersource to identify the submitted request. Returned by all services.
It is also appended to the endpoint of the resource.
On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.
'
submitTimeUtc:
type: string
description: 'Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`
**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).
The `T` separates the date and the time. The `Z` indicates UTC.
Returned by Cybersource for all services.
'
status:
type: string
description: "The status of the submitted transaction.\n\nPossible values:\n - COMPLETED\n - MULTIPLE\n - NO MATCH\n"
paymentAccountInformation:
type: object
properties:
card:
type: object
properties:
type:
type: string
maxLength: 3
description: 'This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.
Possible values from BIN Lookup Service (based on availability and enablement):
- `000`: Unsupported Card Type
- `001`: Visa
- `002`: Mastercard
- `003`: American Express
- `004`: Discover
- `005`: Diners Club
- `007`: JCB
- `036`: Cartes Bancaire
- `042`: Maestro
- `054`: Elo
- `058`: Carnet
- `060`: MADA
- `061`: RuPay
- `062`: China UnionPay
- `064`: Prompt Card
- `067`: Meeza
- `068`: PayPak
- `070`: EFTPOS
- `081`: Jaywan
- `082`: TPN
Glossary of possible values in the payments ecosystem:
- `001`: Visa
- `002`: Mastercard
- `003`: American Express
- `004`: Discover
- `005`: Diners Club
- `006`: Carte Blanche
- `007`: JCB
- `008`: Optima
- `009`: GE Private Label
- `010`: Beneficial Private Label
- `011`: Twinpay Credit Card
- `012`: Twinpay Debit Card
- `013`: Walmart
- `014`: EnRoute
- `015`: Lowe''s Consumer
- `016`: Home Depot Consumer
- `017`: MBNA
- `018`: Dick''s Sportwear
- `019`: Casual Corner
- `020`: Sears
- `021`: JAL
- `023`: Disney Card
- `024`: Switch/Solo
- `025`: Sam''s Club Consumer
- `026`: Sam''s Club Business
- `027`: Nico''s
- `028`: Paymentech Bill Me Later
- `029`: Bebe
- `030`: Restoration Hardware
- `031`: Delta Online
- `032`: Solo
- `033`: Visa Electron
- `034`: Dankort
- `035`: Laser
- `036`: Cartes Bancaire
- `037`: Carta Si
- `040`: UATP
- `041`: HOUSEHOLD
- `042`: Maestro
- `043`: GE MONEY
- `044`: Korean Cards
- `045`: Style Cards
- `046`: J.Crew
- `047`: Payeasecn eWallet
- `048`: Payeasecn Bank Transfer
- `049`: Meijer
- `050`: Hipercard
- `051`: Aura
- `052`: Redecard
- `053`: Orico Card
- `054`: Elo
- `055`: Capital One Private Label
- `057`: Costco Private Label
- `058`: Carnet
- `059`: ValueLink
- `060`: MADA
- `061`: RuPay
- `062`: China UnionPay
- `063`: Falabella Private Label
- `064`: Prompt Card
- `065`: Korean Domestic
- `066`: Banricompras
- `067`: Meeza
- `068`: PayPak
- `070`: EFTPOS
- `071`: Codensa
- `072`: Olimpica
- `073`: Colsubsidio
- `074`: Tuya
- `075`: Sodexo
- `076`: Naranja
- `077`: Cabal
- `078`: DINELCO
- `079`: PANAL
- `080`: EPM
- `081`: Jaywan
- `082`: TPN
'
brandName:
type: string
maxLength: 20
description: "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n"
currency:
type: string
maxLength: 3
description: 'This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.
'
maxLength:
type: string
maxLength: 2
description: 'This field contains the max length of the card.
'
credentialType:
type: string
maxLength: 5
description: "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
brands:
description: Array of brands
type: array
items:
type: object
properties:
type:
type: string
maxLength: 3
description: 'This field contains a 3-digit numeric value that indicates the card type within Cybersource eco-system.
Possible values from BIN Lookup Service (based on availability and enablement):
- `000`: Unsupported Card Type
- `001`: Visa
- `002`: Mastercard
- `003`: American Express
- `004`: Discover
- `005`: Diners Club
- `007`: JCB
- `036`: Cartes Bancaire
- `042`: Maestro
- `054`: Elo
- `058`: Carnet
- `060`: MADA
- `061`: RuPay
- `062`: China UnionPay
- `064`: Prompt Card
- `067`: Meeza
- `068`: PayPak
- `070`: EFTPOS
- `081`: Jaywan
- `082`: TPN
Glossary of possible values in the payments ecosystem:
- `001`: Visa
- `002`: Mastercard
- `003`: American Express
- `004`: Discover
- `005`: Diners Club
- `006`: Carte Blanche
- `007`: JCB
- `008`: Optima
- `009`: GE Private Label
- `010`: Beneficial Private Label
- `011`: Twinpay Credit Card
- `012`: Twinpay Debit Card
- `013`: Walmart
- `014`: EnRoute
- `015`: Lowe''s Consumer
- `016`: Home Depot Consumer
- `017`: MBNA
- `018`: Dick''s Sportwear
- `019`: Casual Corner
- `020`: Sears
- `021`: JAL
- `023`: Disney Card
- `024`: Switch/Solo
- `025`: Sam''s Club Consumer
- `026`: Sam''s Club Business
- `027`: Nico''s
- `028`: Paymentech Bill Me Later
- `029`: Bebe
- `030`: Restoration Hardware
- `031`: Delta Online
- `032`: Solo
- `033`: Visa Electron
- `034`: Dankort
- `035`: Laser
- `036`: Cartes Bancaire
- `037`: Carta Si
- `040`: UATP
- `041`: HOUSEHOLD
- `042`: Maestro
- `043`: GE MONEY
- `044`: Korean Cards
- `045`: Style Cards
- `046`: J.Crew
- `047`: Payeasecn eWallet
- `048`: Payeasecn Bank Transfer
- `049`: Meijer
- `050`: Hipercard
- `051`: Aura
- `052`: Redecard
- `053`: Orico Card
- `054`: Elo
- `055`: Capital One Private Label
- `057`: Costco Private Label
- `058`: Carnet
- `059`: ValueLink
- `060`: MADA
- `061`: RuPay
- `062`: China UnionPay
- `063`: Falabella Private Label
- `064`: Prompt Card
- `065`: Korean Domestic
- `066`: Banricompras
- `067`: Meeza
- `068`: PayPak
- `070`: EFTPOS
- `071`: Codensa
- `072`: Olimpica
- `073`: Colsubsidio
- `074`: Tuya
- `075`: Sodexo
- `076`: Naranja
- `077`: Cabal
- `078`: DINELCO
- `079`: PANAL
- `080`: EPM
- `081`: Jaywan
- `082`: TPN
'
brandName:
type: string
maxLength: 20
description: "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - MADA\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n - MEEZA\n - PAYPAK\n - JAYWAN\n - TPN\n"
features:
type: object
properties:
accountFundingSource:
type: string
maxLength: 20
description: "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
accountFundingSourceSubType:
type: string
maxLength: 20
description: "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
cardProduct:
type: string
maxLength: 50
description: "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
messageType:
type: string
maxLength: 1
description: "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
acceptanceLevel:
type: string
maxLength: 2
description: "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
cardPlatform:
type: string
maxLength: 20
description: "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `CORPORATE`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
comboCard:
type: string
maxLength: 1
description: "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n - 3 (Prepaid Credit and Prepaid Debit combo card)\n"
corporatePurchase:
type: boolean
description: "This field indicates if the instrument can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
healthCard:
type: boolean
description: "This field indicates if the BIN is for healthcare (HSA/FSA). Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false`\n"
sharedBIN:
type: boolean
description: "This field indicates if the BIN is shared by multiple issuers\nPossible values:\n - `true`\n - `false`\n"
posDomesticOnly:
type: boolean
description: "This field indicates if the BIN is valid only for POS domestic usage.\nPossible values:\n - `true`\n - `false`\n"
gamblingAllowed:
type: boolean
description: "This field indicates if gambling transactions are allowed on the BIN.\nPossible values:\n - `true`\n - `false`\n"
commercialCardLevel2:
type: boolean
description: "This field indicates if a transaction on the instrument qualifies for level 2 interchange rates.\nPossible values:\n - `true`\n - `false`\n"
commercialCardLevel3:
type: boolean
description: "This field indicates if a transaction on the instrument qualifies for level 3 interchange rates.\nPossible values:\n - `true`\n - `false`\n"
exemptBIN:
type: boolean
description: "This field indicates if a transaction on the instrument qualifies for government exempt interchange fee.\nPossible values:\n - `true`\n - `false`\n"
accountLevelManagement:
type: boolean
description: "This field indicates if the BIN participates in Account Level Management (ALM).\nPossible values:\n - `true`\n - `false`\n"
onlineGamblingBlock:
type: boolean
description: "This field indicates if online gambling is blocked on the BIN.\nPossible values:\n - `true`\n - `false`\n"
autoSubstantiation:
type: boolean
description: "This field indicates if auto-substantiation is enabled on the BIN.\nPossible values:\n - `true`\n - `false`\n"
flexCredential:
type: boolean
description: "This field indicates if the instrument is a flex credential.\nPossible values:\n - `true`\n - `false`\n"
productId:
type: string
description: "This field contains the Visa-assigned product identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - Q4\n - P\n - AX\n"
productIdSubtype:
type: string
description: "This field contains the Visa-assigned product subtype identifier associated with the BIN. This field is only supported for Visa BINs.\nExample values:\n - BB\n - EX\n - L2\n - C2\n"
threeDSSupport:
type: boolean
description: "This field indicates if the payment instrument supports 3D Secure authentication.\nPossible values:\n - `true`\n - `false`\n"
siEligible:
type: boolean
description: "This field indicates if the payment instrument is eligible for Standing Instructions (recurring payments).\nPossible values:\n - `true`\n - `false`\n"
emiEligible:
type: boolean
description: "This field indicates if the payment instrument is eligible for Equated Monthly Installments (EMI).\nPossible values:\n - `true`\n - `false`\n"
fleetCard:
type: boolean
description: "This field indicates if the BIN is designated for fuel/fleet usage. These specialized BINs support additional Level2/Level 3 transaction data.\nPossible values:\n - `true`\n - `false`\n"
atmEnabled:
type: boolean
description: "This field indicates if the payment instrument is enabled for ATM usage.\nPossible values:\n - `true`\n - `false`\n"
posEnabled:
type: boolean
description: "This field indicates if the payment instrument is enabled for POS usage.\nPossible values:\n - `true`\n - `false`\n"
ecomEnabled:
type: boolean
description: "This field indicates if the payment instrument is enabled for ECOM
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cybersource/refs/heads/main/openapi/cybersource-bin-lookup-api-openapi.yml