Visa BIN Attribute Sharing Service is a platform that allows financial institutions and merchants to exchange information about Visa card transactions in real-time. This service provides valuable insights into cardholder behavior and transaction patterns, helping businesses make informed decisions about fraud prevention, marketing strategies, and customer targeting.
openapi: 3.0.1
info:
title: Visa BIN Attribute Sharing Service
description: ''
version: '1'
servers:
- url: https://sandbox.api.visa.com
description: Sandbox server
security: []
tags:
- name: BIN File Transfer
description: Transfer Account/Token Range File
- name: BIN Files Metadata
description: >-
Get Bin Files Metadata including number of files, file names, sizes,
checksum, creation date.
- name: Full BIN List
description: >-
Access a complete list of all of the Visa BINs and their associated BIN
Attributes
- name: Issuer API
description: API that enables issuers to source acquirer BIN data directly from Visa
- name: Single BIN Lookup
description: Lookup BIN Attributes for a single Payment Account or BIN
paths:
/filedeliveryservice/v1/binFilesMetadata:
post:
tags:
- BIN Files Metadata
summary: BIN Files Metadata
description: >-
Get BIN Files Metadata including number of files, file names, sizes,
checksum, creation date.
operationId: BinFiles metadata lookup using POST
requestBody:
description: BIN Files Metadata request payload
content:
application/json:
schema:
$ref: '#/components/schemas/binFilesMetadataRequest'
examples:
Request 1:
summary: Request 1
value:
requestHeader:
requestTS: '2021-02-10T12:26:50.002'
requestMessageId: reqstMsgID1
requestData:
paymentAccountType: P
Request 2:
summary: Request 2
value:
requestHeader:
requestTS: '2021-02-10T12:26:50.002'
requestMessageId: reqstMsgID1
requestData:
paymentAccountType: T
required: true
responses:
'200':
description: BinFilesMetadata Response
content:
application/json:
schema:
$ref: '#/components/schemas/binFilesMetadataResponse'
'400':
description: Request Data Invalid
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes'
x-operationVersions:
- label: v1 - Latest
operationPointer: '#/paths/~1filedeliveryservice~1v1~1binFilesMetadata/post'
default: false
x-codegen-request-body-name: Bin Files Metadata Request
/vbass/v1/files/metadata:
post:
tags:
- Issuer API
summary: Files Metadata
description: >-
Get the metadata for the VBASS files including the count of files, file
names, size, checksum and creation date.
operationId: VBASS Files metadata lookup using POST
requestBody:
description: VBASS Files Metadata request payload
content:
application/json:
schema:
$ref: '#/components/schemas/vbassFilesMetadataRequest'
examples:
Default:
summary: Default
value:
requestHeader:
requestTS: '2022-12-01T21:26:52.021'
requestMessageId: TestGenFilesMetadata
requestData:
fileType: ACQ
required: true
responses:
'200':
description: VBASSFilesMetadata Response
content:
application/json:
schema:
$ref: '#/components/schemas/vbassFilesMetadataResponse'
examples:
Default:
summary: Default
value:
responseHeader:
responseTS: '2024-02-08T23:54:24.245'
responseMessageId: 108VDP41105220240208235424237
requestMessageId: TestGenFilesMetadata
responseData:
fileDetails:
- fileName: VBASS_ACQ_02082024_1.csv
fileSize: 2411325
checkSum: ae0d04247d2bb5fc0fb0f711af51ef29
rowCount: 25318
totalNumberOfFiles: 1
filesCreationDate: '2024-02-08'
fileType: ACQ
'400':
description: Request Data Invalid
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes'
x-operationVersions:
- label: v1 - Latest
operationPointer: '#/paths/~1vbass~1v1~1files~1metadata/post'
default: false
x-codegen-request-body-name: VBASS Files Metadata Request
x-hideTryIt: true
/vbass/v1/files/transfers:
post:
tags:
- Issuer API
summary: File Transfer
description: The VBASS File Transfer API endpoint allows the download of VBASS File
operationId: VBASS File Transfer - POST
requestBody:
description: VBASS File Transfer request payload
content:
application/json:
schema:
$ref: '#/components/schemas/vbassFileTransferRequest'
examples:
Default:
summary: Default
value:
requestHeader:
requestTS: '2021-02-10T21:26:52.021'
requestMessageId: TestGenFileTransfers
requestData:
fileName: VBASS_ACQ_02082024_1.csv
required: true
responses:
'200':
description: VBASS File Transfer Response
content:
application/json:
schema:
$ref: '#/components/schemas/vbassFileTransferResponse'
examples:
Default:
summary: Default
value: >-
Sample response will contain csv file in a comma-separated
format
'400':
description: Request Data Invalid
content: {}
'401':
description: Unauthorized
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes-1'
x-operationVersions:
- label: v1 - Latest
operationPointer: '#/paths/~1vbass~1v1~1files~1transfers/post'
default: false
x-codegen-request-body-name: VBASS File Transfer Request
x-hideTryIt: true
/v1/paymentAccountLookup:
post:
tags:
- Single BIN Lookup
summary: PAN TOKEN Lookup Using POST
description: Get all the values related to PAN/TOKEN
operationId: PAN TOKEN Lookup Using POST V1
requestBody:
description: PAN/TOKEN Lookup request payload
content:
application/json:
schema:
$ref: '#/components/schemas/paymentAccountLookupRequest'
examples:
Default:
summary: Default
value:
requestHeader:
requestTS: '2024-01-15T22:05:00.000'
requestMessageID: test123
requestData:
paymentAccountType: P
paymentAccount: '4259077000001230'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/paymentAccountLookupResponseV1'
examples:
Default:
summary: Default
value:
wsStatus:
statusDesc: Success
statusCode: CDI000
responseData:
platformCd: GV
accountFundingSourceCd: R
accountBusName: ABD & COMPANY
productID: S2
paymentAccountType: P
accountRegionCode: '06'
issuerBillingCurrCd: MRO
accountCtryAlpha2Code: MR
issuerBin: '425907'
productIDName: Visa Government Purchasing
accountFundingSourceSubtypeCd: 'N'
'300':
description: Requesting Client IP is invalid
content: {}
'400':
description: Request Data Invalid
content: {}
'401':
description: Unauthorized
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes-2'
x-operationVersions:
- label: v1
operationPointer: '#/paths/~1v1~1paymentAccountLookup/post'
default: false
- label: v2 - Latest
operationPointer: '#/paths/~1v2~1paymentAccountLookup/post'
default: false
x-codegen-request-body-name: PAN TOKEN Lookup Request
x-hideTryIt: true
/v2/paymentAccountLookup:
post:
tags:
- Single BIN Lookup
summary: PAN TOKEN Lookup Using POST V2
description: >-
Get all the values related to PAN/TOKEN<br><br>Access to Visa BIN
Attributes such as Issuer BIN, Issuer Country , Issuer Billing Currency
and Product Identifiers such as Product ID/name, Product Platform, Card
type, Card Subtype for any single payment account
operationId: PAN TOKEN Lookup Using POST V2
requestBody:
description: PAN/TOKEN Lookup request payload
content:
application/json:
schema:
$ref: '#/components/schemas/paymentAccountLookupRequest-1'
examples:
Default:
summary: Default
value:
requestHeader:
requestTS: '2024-01-15T22:05:00.000'
requestMessageID: test123
requestData:
paymentAccountType: P
paymentAccount: '4259077000001230'
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/paymentAccountLookupResponseV2-1'
examples:
Default:
summary: Default
value:
wsStatus:
statusDesc: Success
statusCode: CDI000
responseData:
commrclCrdLvl3EnhInd: 'N'
accountFundingSourceCd: R
binLength: '6'
productID: S2
paymentAccountType: P
accountRegionCode: '06'
accountCtryAlpha2Code: MR
posDomesticOnlyInd: 'N'
onlineGamblBlockInd: 'Y'
comboCrdCd: 'N'
accountFundingSourceSubtypeCd: 'N'
commrclCrdLvl2Ind: 'N'
platformCd: GV
accountBusName: ABD & COMPANY
multiAccountAccessInd: 'N'
issuerBillingCurrCd: MRO
almInd: 'N'
vauInd: 'N'
brandCd: VISA
autoSubstntnInd: 'N'
issuerBin: '425907'
sharedBinInd: 'Y'
productIDName: Visa Government Purchasing
regulatedBinCd: R
'400':
description: Request Data Invalid
content: {}
'401':
description: Unauthorized
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes-2'
x-codegen-request-body-name: PAN TOKEN Lookup Request
x-hideTryIt: true
/v2/binRangeDetails:
post:
tags:
- Full BIN List
summary: Bin Range Details Using POST V2
description: >-
The Full BIN List API provides access to Visa BIN Attributes such as
Issuer BIN, Issuer Country, Issuer Billing Currency and Product
Identifiers such as Product ID/name, Product Platform, Card type , Card
Subtype
operationId: Bin Range Details Using POST V2
requestBody:
description: Bin Range Details request payload
content:
application/json:
schema:
$ref: '#/components/schemas/BinRangeDetailsRequestV2'
examples:
Default:
summary: Default
value:
requestHeader:
requestTS: '2024-01-01T23:10:41.000'
requestMessageID: test123
requestData:
binRangeSearchIndex: '0'
paymentAccountType: P
binRangeCount: '100'
required: true
responses:
'200':
description: BinRangeDetails Response
content:
application/json:
schema:
$ref: '#/components/schemas/BinRangeDetailsResponseV2'
examples:
Default:
summary: Default
value:
numRecordsReturned: '100'
areNextOffsetRecordsAvailable: 'Y'
responseHeader:
responseMessageID: 34CACCTDTL2750820220617223228171
responseData:
- binRangeMaxNum: '401975999999999999999'
productID: B
binRangePaymentAccountType: P
accountRegionCode: '01'
accountCtryAlpha2Code: TL
posDomesticOnlyInd: 'N'
comboCrdCd: A
accountFundingSourceSubtypeCd: 'N'
multiAccountAccessInd: 'N'
issuerBillingCurrCd: TPE
autoSubstntnInd: 'Y'
issuerBin: '401975'
productIDName: Visa Infinite Privilege
commrclCrdLvl3EnhInd: 'N'
accountFundingSourceCd: R
binLength: '6'
onlineGamblBlockInd: 'N'
binRangeMinNum: '401975000000000000000'
commrclCrdLvl2Ind: 'N'
platformCd: CN
accountBusName: A2B2 BANK
almInd: 'N'
vauInd: 'Y'
brandCd: VISA
sharedBinInd: 'N'
regulatedBinCd: 'N'
- binRangeMaxNum: '402201050999999999999'
productID: E
binRangePaymentAccountType: P
accountRegionCode: '04'
accountCtryAlpha2Code: US
posDomesticOnlyInd: 'N'
comboCrdCd: C
accountFundingSourceSubtypeCd: ''
multiAccountAccessInd: 'N'
issuerBillingCurrCd: USD
autoSubstntnInd: 'N'
issuerBin: '402201'
productIDName: Visa Business
commrclCrdLvl3EnhInd: 'N'
accountFundingSourceCd: D
binLength: '6'
onlineGamblBlockInd: 'N'
binRangeMinNum: '402201050000000000000'
commrclCrdLvl2Ind: 'N'
platformCd: BZ
accountBusName: ABD MARKETING
almInd: 'N'
vauInd: 'N'
brandCd: PROP
sharedBinInd: 'N'
regulatedBinCd: 'N'
- binRangeMaxNum: '414718009999999999999'
productID: S5
binRangePaymentAccountType: P
accountRegionCode: '05'
accountCtryAlpha2Code: PE
posDomesticOnlyInd: 'N'
comboCrdCd: 'N'
accountFundingSourceSubtypeCd: 'N'
multiAccountAccessInd: S
issuerBillingCurrCd: PEN
autoSubstntnInd: 'N'
issuerBin: '41471800'
productIDName: Visa Signature
commrclCrdLvl3EnhInd: 'N'
accountFundingSourceCd: R
binLength: '8'
onlineGamblBlockInd: 'N'
binRangeMinNum: '414718000000000000000'
commrclCrdLvl2Ind: 'N'
platformCd: CO
accountBusName: ABD BANK, NATIONAL ASSOCIATION
almInd: 'N'
vauInd: 'N'
brandCd: VISA
sharedBinInd: 'N'
regulatedBinCd: 'N'
responseStatus:
statusDescription: Success
statusCode: CDI000
totalRecordsCount: '8203810'
'400':
description: Request Data Invalid
content: {}
'401':
description: Unauthorized
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes-3'
x-operationVersions:
- label: v1
operationPointer: '#/paths/~1v1~1binRangeDetails/post'
default: false
- label: v2 - Latest
operationPointer: '#/paths/~1v2~1binRangeDetails/post'
default: false
x-codegen-request-body-name: Bin Range Details Request
x-hideTryIt: true
/v1/binRangeDetails:
post:
tags:
- Full BIN List
summary: Bin Range Details Using POST
description: Full Bin List
operationId: Bin Range Details Using POST V1
requestBody:
description: Bin Range Details request payload
content:
application/json:
schema:
$ref: '#/components/schemas/BinRangeDetailsRequestV1-1'
examples:
Default:
summary: Default
value:
requestHeader:
requestTS: '2024-02-01T23:10:41.000'
requestMessageID: test123
requestData:
binRangeSearchIndex: '0'
binRangeCount: '100'
required: true
responses:
'200':
description: BinRangeDetails Response
content:
application/json:
schema:
$ref: '#/components/schemas/BinRangeDetailsResponseV1-1'
examples:
Default:
summary: Default
value:
numRecordsReturned: '100'
areNextOffsetRecordsAvailable: 'Y'
responseHeader:
responseMessageID: 34CACCTDTL2750820220617223228171
responseData:
- binRangeMaxNum: '401975999999999999999'
accountFundingSourceCd: R
productID: B
binRangePaymentAccountType: P
accountRegionCode: '01'
accountCtryAlpha2Code: TL
binRangeMinNum: '401975000000000000000'
accountFundingSourceSubtypeCd: 'N'
platformCd: CN
accountBusName: A2B2 BANK
issuerBillingCurrCd: TPE
issuerBin: '401975'
productIDName: Visa Infinite Privilege
- binRangeMaxNum: '402201050999999999999'
accountFundingSourceCd: D
productID: E
binRangePaymentAccountType: P
accountRegionCode: '04'
accountCtryAlpha2Code: US
binRangeMinNum: '402201050000000000000'
accountFundingSourceSubtypeCd: ''
platformCd: BZ
accountBusName: ABD MARKETING
issuerBillingCurrCd: USD
issuerBin: '402201'
productIDName: Visa Business
- binRangeMaxNum: '414718009999999999999'
accountFundingSourceCd: R
productID: S5
binRangePaymentAccountType: P
accountRegionCode: '05'
accountCtryAlpha2Code: PE
binRangeMinNum: '414718000000000000000'
accountFundingSourceSubtypeCd: 'N'
platformCd: CO
accountBusName: ABD BANK, NATIONAL ASSOCIATION
issuerBillingCurrCd: PEN
issuerBin: '41471800'
productIDName: Visa Signature
responseStatus:
statusDescription: Success
statusCode: CDI000
totalRecordsCount: '8203810'
'300':
description: Requesting Client IP is invalid
content: {}
'400':
description: Request Data Invalid
content: {}
'401':
description: Unauthorized
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes-3'
x-codegen-request-body-name: Bin Range Details Request
/filedeliveryservice/v1/binFileTransfer:
post:
tags:
- BIN File Transfer
summary: BIN File Transfer
description: Get access to a BIN Account/Token Range file in csv format
operationId: Bin File Transfer - POST
requestBody:
description: BIN File Transfer request payload
content:
application/json:
schema:
$ref: '#/components/schemas/BinFileTransferRequest'
examples:
Default:
summary: Default
value:
requestHeader:
requestTS: '2017-02-15T22:05:00.000'
requestMessageId: testAnna
requestData:
fileName: VBASS_TR_LEVEL3_03252021_79.csv
required: true
responses:
'200':
description: BinFileTransfer Response
content:
application/json:
schema:
$ref: '#/components/schemas/BinFileTransferResponse'
examples:
Default:
summary: Default
value: >-
Sample response will contain csv file in a comma-separated
format
'400':
description: Request Data Invalid
content: {}
'401':
description: Unauthorized
content: {}
'500':
description: Error Codes
content:
application/json:
schema:
$ref: '#/components/schemas/errorCodes-1'
x-operationVersions:
- label: v1 - Latest
operationPointer: '#/paths/~1filedeliveryservice~1v1~1binFileTransfer/post'
default: false
x-codegen-request-body-name: BIN File Transfer Request
x-hideTryIt: true
components:
schemas:
BinRangeDetailsRequestV1-1:
title: BinRangeDetailsRequest
type: object
properties:
requestData:
$ref: '#/components/schemas/requestDataV1-1'
requestHeader:
$ref: '#/components/schemas/requestHeader-4'
vbassFilesMetadataRequest:
title: VBASSFilesMetadataRequest
type: object
properties:
requestData:
$ref: '#/components/schemas/requestData-1'
requestHeader:
$ref: '#/components/schemas/requestHeader-1'
vbassFileTransferRequest:
title: vbassFileTransferRequest
type: object
properties:
requestData:
$ref: '#/components/schemas/requestData-2'
requestHeader:
$ref: '#/components/schemas/requestHeader-2'
errorCodes:
title: ErrorCodes
type: object
properties:
CDI001:
type: object
description: Internal service failure
CDI003:
type: object
description: Missing Required Attributes
CDI012:
type: object
description: Request header length is invalid
CDI071:
type: object
description: Request data invalid
CDI092:
type: object
description: No data
CDI098:
type: object
description: Invalid RequestTS format
CDI251:
type: object
description: Client configuration incomplete, reach out to [email protected]
BinFileTransferResponse:
title: BinFileTransferResponse
type: object
responseHeader:
title: responseHeader
type: object
properties:
responseTS:
maxLength: 23
minLength: 23
type: string
description: Date and time at which Response is sent (up to milliseconds in UTC)
format: YYYY-MM-DDThh:mm:ss.sss
example: '2023-02-17T06:31:31.194'
requestMessageId:
maxLength: 30
minLength: 1
type: string
description: >-
A string which uniquely identifies the service request. Requesting
application need to create this unique message Id
example: reqMsgId456
responseMessageId:
maxLength: 33
minLength: 33
type: string
description: >-
A combination of Service Id, Application Id, an Integer and current
Timestamp that uniquely identifies the current request-response
processing
example: 106VDP87035320230217063131177
paymentAccountLookupRequest-1:
type: object
properties:
requestData:
$ref: '#/components/schemas/paymentAccountLookupRequestData-1'
requestHeader:
$ref: '#/components/schemas/paymentAccountLookupRequestHeader-1'
responseDataV2-1:
type: object
properties:
almInd:
maxLength: 1
minLength: 0
type: string
description: >-
Indicates if BIN or Account Range participate in Account Level
Management
vauInd:
maxLength: 1
minLength: 0
type: string
description: Visa Account Updater enabled indicator
brandCd:
maxLength: 4
minLength: 0
type: string
description: >-
Identifies if the brand or brands is associated with the account
range.<br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section8">Brand
Indicator</a>
binLength:
maxLength: 2
minLength: 0
type: string
description: Provides BIN length - 6 or 8 digits
issuerBin:
maxLength: 8
minLength: 0
type: string
description: Issuer BIN of requested PAN/TOKEN
productID:
maxLength: 2
minLength: 0
type: string
description: >-
An identifier associated with a unique card product - combination of
card brand, platform, class and scheme equates to a unique product
ID.<br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section0">Product
ID</a>
comboCrdCd:
maxLength: 1
minLength: 0
type: string
description: >-
Indicator for combo card <br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section6">Combo
Card Indicator</a>
platformCd:
maxLength: 2
minLength: 0
type: string
description: >-
The code of product platform, e.g. Business, Consumer, Commercial,
Government.<br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section3">Product
Platform Code</a>
sharedBinInd:
maxLength: 1
minLength: 0
type: string
description: Set to true if BIN shared by multiple issuers
productIDName:
maxLength: 50
minLength: 0
type: string
description: >-
The name associated with the product ID, e.g. Visa Traditional, Visa
Signature, Visa Government Purchasing, etc.<br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section0">Product
ID</a>
accountBusName:
maxLength: 240
minLength: 0
type: string
description: Issuer Name
regulatedBinCd:
maxLength: 1
minLength: 0
type: string
description: >-
Indicator for regulated BINs <br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section7">Regulated
BINs Indicator</a>
autoSubstntnInd:
maxLength: 1
minLength: 0
type: string
description: Auto Substantiation enabled indicator
accountRegionCode:
maxLength: 2
minLength: 0
type: string
description: >-
Issuer Region <br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section9">Issuer
Region Code</a>
commrclCrdLvl2Ind:
maxLength: 1
minLength: 0
type: string
description: Indicates if transaction qualifies for Level 2 interchange rates
paymentAccountType:
maxLength: 1
minLength: 0
type: string
description: Identifier for whether account is a PAN ('P') or Token ('T')
posDomesticOnlyInd:
maxLength: 1
minLength: 0
type: string
description: Domestic Only BIN or Account Ranges
issuerBillingCurrCd:
maxLength: 3
minLength: 0
type: string
description: >-
Issuer Billing Currency Code <br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section5">Currency
Code</a>
onlineGamblBlockInd:
maxLength: 1
minLength: 0
type: string
description: Indicates whether Online Gambling permitted or not
commrclCrdLvl3EnhInd:
maxLength: 1
minLength: 0
type: string
description: Indicates if transaction qualifies for Level 3 interchange rates
accountCtryAlpha2Code:
maxLength: 2
minLength: 0
type: string
description: >-
Country Code Alpha Code <br>Refer to <a
href="/capabilities/visa-bin-attribute-sharing-service/docs-request-response-codes#section4">Country
Code</a>
multiAccountAccessInd:
maxLength: 1
minLength: 0
type: string
description: >-
Multi Account Access indicator <br>Refer to <a
href="/capabilities/vis
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visa/refs/heads/main/openapi/visa-bin-attribute-sharing.yml