Visa B2B Connect API Reference
Visa B2B Connect
Search API Reference
- Getting Started
- Authentication Method
- How to Use Visa B2B Connect
- Reason Codes
- Error Codes
- Request & Response Codes
Bank API
The VISA B2B Connect REST API allows developers to perform operations from a company or bank perspective. The VISA B2B Connect API allows you to create and update profiles or retrieve information that is relevant to you.
Get Bank v1 - Latest
Get Bank
Request
path Parameters
| bankId required |
string [ 8 .. 11 ] characters The BID (Visa issued Business ID) (length - 8) or BIC corresponding to BID (length - 8 or 11). BankId = 89000100, 67778901, ABDGAU36, BARCGB22, 12345678 |
Responses
200
ok
Response Schema: application/json
| getBanksResponse | object Successful request |
| --- | --- |
| bankId required |
string [ 8 .. 11 ] characters Visa issued Business ID (BID) 8-digits. |
| bankProfile required |
object |
| --- | --- |
| address required |
object |
| --- | --- |
| city required |
string |
| countryDisplayName required |
string |
| countryIsoCode required |
integer |
| line1 required |
string The address except the unit number all on one line. |
| state required |
string |
| unitNo required |
string |
| zipCode required |
string |
| bankName required |
string The name of the bank in question. |
| defaultCurrency required |
string |
| defaultCurrencyIsoCode required |
integer |
| primaryContact required |
object |
| --- | --- |
| email required |
string |
| jobTitle required |
string |
| name required |
string |
| phone required |
string |
| secondaryContact required |
object |
| --- | --- |
| email required |
string |
| jobTitle required |
string |
| name required |
string |
| phone required |
string |
| unifiedPaymentId required |
Array of objects |
| Array |
| type | object |
| clearingMemberId | string The clearing member id of the non bic associated debtor bank |
| clearingMemberIdType | string The clearing member id type of the non bic associated debtor bank |
| frequencyType | string The category of the frequency that is being requested, possible values are: Every Day and Upon Payment |
| recipientEmail | string The email of the recipient |
| settlementAccountBic | Array of objects |
| Array |
| type | object |
| blockedCorridors required |
object Shows the countries that have been blocked both at the system and at the participant level. |
| --- | --- |
| blockedCountries | Array of objects |
| Array |
| blockedDesc | string Indicates if a country is blocked and what category of entity blocked it. Potential Statuses: visaBlocked, bankBlocked, companyBlocked, unblocked. |
| countryCode | string 3 characters Valid supported ISO 3166 3-character country code. |
| countryDisplayName | string Name of country. |
| isoCountryCode | integer Valid supported ISO 3166 3-digit numeric country code. |
| lastUpdated required |
string format - date |
| statusText required |
string |
| supportedCurrencies required |
Array of objects |
| Array |
| currencyAlphaCode | string |
| currencyIsoCode | integer |
| default | boolean |
| transactionLimits required |
object Shows the default transaction limits (in payment currency) settings for enrolled commercial customers. |
| --- | --- |
| customLimits required |
boolean True if they have set up custom limits. False if they have default limits. |
| dailyVolume required |
string The maximum amount of funds that can be exchanged across all transactions each day. (Cannot exceed global-level transaction limits). |
| singleTransaction required |
string The maximum amount of funds that can be exchanged in one transaction. |
| bankBic | string BIC corresponding to the bank |
400
Bad Request
Response Schema: application/json
| errorMessages | Array of objects |
| Array |
| description | object |
| type | object |
Get Bank by Bank BIC
Get Bank by Bank BIC
Get Bank by Clearing Member ID
Get Bank by Bank ID
Response samples
- 200
- 400
application/json
{"bankProfile": {"unifiedPaymentId": ["8891122"],
"address": {"zipCode": "78729",
"unitNo": "120",
"city": "Austin",
"countryIsoCode": 840,
"state": "Texas",
"line1": "12401 Los Indios Trl",
"countryDisplayName": "USA"
},
"defaultCurrency": "USD",
"frequencyType": "Upon Payment",
"primaryContact": {"phone": "897-099-7878",
"jobTitle": "SVP",
"name": "Jim Smith",
"email": "jsmith@gmail.com"
},
"clearingMemberIdType": null,
"settlementAccountBic": ["VDPVUS22XXX"],
"bankName": "XYZ",
"defaultCurrencyIsoCode": 840,
"recipientEmail": "abc@example.com",
"clearingMemberId": null,
"secondaryContact": {"phone": "897-099-7878",
"jobTitle": "SVP",
"name": "Jim Smith",
"email": "jsmith@gmail.com"
}
},
"lastUpdated": "11/02/2023",
"supportedCurrencies": [{"currencyAlphaCode": "USD",
"default": true,
"currencyIsoCode": 840},
{"currencyAlphaCode": "BEF",
"default": false,
"currencyIsoCode": 56}],
"bankId": "89000100",
"blockedCorridors": {"blockedCountries": [{"blockedDesc": "VISABLOCKED",
"countryCode": "CUB",
"isoCountryCode": 192,
"countryDisplayName": "CUBA"}]},
"statusText": "In Process",
"bankBic": "BARCGB22",
"transactionLimits": {"customLimits": true,
"dailyVolume": "99999999990",
"singleTransaction": "250000"}
}