# Visa B2B Connect

## Search API Reference

- [Getting Started](https://developer.visa.com/capabilities/vba/docs-getting-started)
- [Authentication Method](https://developer.visa.com/capabilities/vba/docs-authentication)
- [How to Use Visa B2B Connect](https://developer.visa.com/capabilities/vba/docs-how-to)
- [Reason Codes](https://developer.visa.com/capabilities/vba/docs-reason-codes)
- [Error Codes](https://developer.visa.com/pages/visa-developer-error-codes)
- [Request & Response Codes](https://developer.visa.com/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<br>required | string \[ 8 .. 11 \] characters <br>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<br>Successful request |
| |     |     |
| --- | --- |
| bankId<br>required | string \[ 8 .. 11 \] characters <br>Visa issued Business ID (BID) 8-digits. |
| bankProfile<br>required | object |
| |     |     |
| --- | --- |
| address<br>required | object |
| |     |     |
| --- | --- |
| city<br>required | string |
| countryDisplayName<br>required | string |
| countryIsoCode<br>required | integer |
| line1<br>required | string<br>The address except the unit number all on one line. |
| state<br>required | string |
| unitNo<br>required | string |
| zipCode<br>required | string | |
| bankName<br>required | string<br>The name of the bank in question. |
| defaultCurrency<br>required | string |
| defaultCurrencyIsoCode<br>required | integer |
| primaryContact<br>required | object |
| |     |     |
| --- | --- |
| email<br>required | string |
| jobTitle<br>required | string |
| name<br>required | string |
| phone<br>required | string | |
| secondaryContact<br>required | object |
| |     |     |
| --- | --- |
| email<br>required | string |
| jobTitle<br>required | string |
| name<br>required | string |
| phone<br>required | string | |
| unifiedPaymentId<br>required | Array of objects |
| Array

|     |     |
| --- | --- |
| type | object | |
| clearingMemberId | string<br>The clearing member id of the non bic associated debtor bank |
| clearingMemberIdType | string<br>The clearing member id type of the non bic associated debtor bank |
| frequencyType | string<br>The category of the frequency that is being requested, possible values are: Every Day and Upon Payment |
| recipientEmail | string<br>The email of the recipient |
| settlementAccountBic | Array of objects |
| Array

|     |     |
| --- | --- |
| type | object | | |
| blockedCorridors<br>required | object<br>Shows the countries that have been blocked both at the system and at the participant level. |
| |     |     |
| --- | --- |
| blockedCountries | Array of objects |
| Array

|     |     |
| --- | --- |
| blockedDesc | string<br>Indicates if a country is blocked and what category of entity blocked it. Potential Statuses: visaBlocked, bankBlocked, companyBlocked, unblocked. |
| countryCode | string 3 characters <br>Valid supported ISO 3166 3-character country code. |
| countryDisplayName | string<br>Name of country. |
| isoCountryCode | integer<br>Valid supported ISO 3166 3-digit numeric country code. | | |
| lastUpdated<br>required | string<br>format - date |
| statusText<br>required | string |
| supportedCurrencies<br>required | Array of objects |
| Array

|     |     |
| --- | --- |
| currencyAlphaCode | string |
| currencyIsoCode | integer |
| default | boolean | |
| transactionLimits<br>required | object<br>Shows the default transaction limits (in payment currency) settings for enrolled commercial customers. |
| |     |     |
| --- | --- |
| customLimits<br>required | boolean<br>True if they have set up custom limits. False if they have default limits. |
| dailyVolume<br>required | string<br>The maximum amount of funds that can be exchanged across all transactions each day. (Cannot exceed global-level transaction limits). |
| singleTransaction<br>required | string<br>The maximum amount of funds that can be exchanged in one transaction. | |
| bankBic | string<br>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

---

```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"}
}
```