```json { "openapi": "3.1.0", "info": { "title": "Visa B2B Connect", "description": "A global technology platform designed to enable direct and predictable exchange of value for banks and corporate clients.", "version": "1" }, "servers": [ { "url": "https://sandbox.api.visa.com", "description": "Sandbox server" } ], "security": [], "tags": [ { "name": "Bank API", "description": "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 retreive information that is relevant to you." }, { "name": "Company API", "description": "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 retreive information that is relevant to you." }, { "name": "Payments API", "description": "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 retreive information that is relevant to you." }, { "name": "Reference Data API", "description": "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 retreive information that is relevant to you." } ], "paths": { "/visab2bconnect/v1/banks/{bankId}": { "get": { "tags": [ "Bank API" ], "summary": "Get Bank", "description": "Get Bank", "operationId": "Get Bank", "parameters": [ { "name": "bankId", "in": "path", "description": "The BID (Visa issued Business ID) (length - 8) or BIC corresponding to BID (lenghth - 8 or 11). BankId = 89000100, 67778901, ABDGAU36, BARCGB22, 12345678", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 11, "minLength": 8, "type": "string" } } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "getBanksResponse": { "required": [ "bankId", "bankProfile", "blockedCorridors", "lastUpdated", "statusText", "supportedCurrencies", "transactionLimits" ], "type": "object", "properties": { "bankId": { "maxLength": 11, "minLength": 8, "type": "string", "description": "Visa issued Business ID (BID) 8-digits." }, "bankBic": { "type": "string", "description": "BIC corresponding to the bank" }, "statusText": { "type": "string" }, "bankProfile": { "required": [ "address", "bankName", "defaultCurrency", "defaultCurrencyIsoCode", "primaryContact", "secondaryContact", "unifiedPaymentId" ], "type": "object", "properties": { "address": { "required": [ "city", "countryDisplayName", "countryIsoCode", "line1", "state", "unitNo", "zipCode" ], "type": "object", "properties": { "city": { "type": "string" }, "line1": { "type": "string", "description": "The address except the unit number all on one line." }, "state": { "type": "string" }, "unitNo": { "type": "string" }, "zipCode": { "type": "string" }, "countryIsoCode": { "type": "integer" }, "countryDisplayName": { "type": "string" } } }, "bankName": { "type": "string", "description": "The name of the bank in question." }, "frequencyType": { "type": "string", "description": "The category of the frequency that is being requested, possible values are: Every Day and Upon Payment" }, "primaryContact": { "required": [ "email", "jobTitle", "name", "phone" ], "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "jobTitle": { "type": "string" } } }, "recipientEmail": { "type": "string", "description": "The email of the recipient" }, "defaultCurrency": { "type": "string" }, "clearingMemberId": { "type": "string", "description": "The clearing member id of the non bic asociated debtor bank" }, "secondaryContact": { "required": [ "email", "jobTitle", "name", "phone" ], "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "jobTitle": { "type": "string" } } }, "unifiedPaymentId": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } }, "clearingMemberIdType": { "type": "string", "description": "The clearing member id type of the non bic asociated debtor bank" }, "settlementAccountBic": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } }, "defaultCurrencyIsoCode": { "type": "integer" } } }, "lastUpdated": { "type": "string", "description": "format - date" }, "blockedCorridors": { "type": "object", "properties": { "blockedCountries": { "type": "array", "items": { "type": "object", "properties": { "blockedDesc": { "type": "string", "description": "Indicates if a country is blocked and what category of entity blocked it. Potential Statuse: visaBlocked, bankBlocked, companyBlocked, unblocked." }, "countryCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "Valid supported ISO 3166 3-character country code." }, "isoCountryCode": { "type": "integer", "description": "Valid supported ISO 3166 3-digit numeric country code." }, "countryDisplayName": { "type": "string", "description": "Name of country." } } } } }, "description": "Shows the countries that have been blocked both at the system and at the participant level." }, "transactionLimits": { "required": [ "customLimits", "dailyVolume", "singleTransaction" ], "type": "object", "properties": { "dailyVolume": { "type": "string", "description": "The maximum amount of funds that can be exchanged across all transactions each day. (Cannot exceed global-level transaction limits)." }, "customLimits": { "type": "boolean", "description": "True if they have set up custom limits. False if they have default limits." }, "singleTransaction": { "type": "string", "description": "The maximum amount of funds that can be exchanged in one transaction." } }, "description": "Shows the default transaction limits (in payment currency) settings for enrolled commercial customers." }, "supportedCurrencies": { "type": "array", "items": { "type": "object", "properties": { "default": { "type": "boolean" }, "currencyIsoCode": { "type": "integer" }, "currencyAlphaCode": { "type": "string" } } } } }, "description": "Successful request" } } }, "examples": { "Get Bank by Bank BIC": { "summary": "Get Bank by Bank BIC", "value": { "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" } } }, "Get Bank by Clearing Member ID": { "summary": "Get Bank by Clearing Member ID", "value": { "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": "USABA", "settlementAccountBic": [ "VDPVUS22XXX" ], "bankName": "XYZ", "defaultCurrencyIsoCode": 840, "recipientEmail": "abc@example.com", "clearingMemberId": "082900872", "secondaryContact": { "phone": "897-099-7878", "jobTitle": "SVP", "name": "Jim Smith", "email": "jsmith@gmail.com" } }, "lastUpdated": "01/31/2024", "supportedCurrencies": [ { "currencyAlphaCode": "USD", "default": true, "currencyIsoCode": 840 }, { "currencyAlphaCode": "BEF", "default": false, "currencyIsoCode": 56 } ], "bankId": "12345678", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "VISABLOCKED", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "CUBA" } ] }, "statusText": "In Process", "bankBic": null, "transactionLimits": { "customLimits": true, "dailyVolume": "99999999990", "singleTransaction": "250000" } } }, "Get Bank by Bank ID": { "summary": "Get Bank by Bank ID", "value": { "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": "67778901", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "VISABLOCKED", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "CUBA" } ] }, "statusText": "In Process", "bankBic": "ABDGAU36", "transactionLimits": { "customLimits": true, "dailyVolume": "99999999990", "singleTransaction": "250000" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" }, "description": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1banks~1{bankId}/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/banks/netPosition": { "get": { "tags": [ "Bank API" ], "summary": "Get the Net Position of a Bank", "description": "", "operationId": "Get the Net Position of a Bank", "parameters": [ { "name": "bankId", "in": "query", "description": "The BID (Visa issued Business ID) (length - 8) or BIC corresponding to BID (lenghth - 8 or 11). For Sandbox testing use bankId = 89000100, 67778901, ABDGAU36, BARCGB22, 12345678 and also if searching with keyworkd use currency = USD, GBP, INR", "required": true, "style": "form", "explode": true, "schema": { "maxLength": 11, "minLength": 8, "type": "string" } }, { "name": "currency", "in": "query", "description": "The currency Alpha code. For Sandbox testing use USD as alpha currency code", "required": false, "explode": false, "schema": { "type": "array", "items": { "type": "object" } } } ], "responses": { "200": { "description": "ok", "content": { "Get Net Position by BID/BIC": { "example": { "netPosition": [ { "asOfDate": "2023-11-09 20:33:31 GMT", "bankFunds": "500", "netPosition": "1000", "incomingAmount": "2500", "outgoingAmount": "1500", "upcomingWindow": "2023-11-10 10:00:00 GMT", "currencyAlphaCode": "USD" }, { "asOfDate": "2023-11-09 20:33:31 GMT", "bankFunds": "500", "netPosition": "1000", "incomingAmount": "2500", "outgoingAmount": "1500", "upcomingWindow": "2023-11-10 10:00:00 GMT", "currencyAlphaCode": "GBP" }, { "asOfDate": "2023-11-09 20:33:31 GMT", "bankFunds": "500", "netPosition": "1000", "incomingAmount": "2500", "outgoingAmount": "1500", "upcomingWindow": "2023-11-10 10:00:00 GMT", "currencyAlphaCode": "INR" } ] } }, "Get Net Position by Alpha Currency Code": { "example": { "netPosition": [ { "asOfDate": "2023-11-09 20:35:39 GMT", "bankFunds": "500", "netPosition": "1000", "incomingAmount": "2500", "outgoingAmount": "1500", "upcomingWindow": "2023-11-10 10:00:00 GMT", "currencyAlphaCode": "USD" } ] } }, "application/json": { "schema": { "type": "object", "properties": { "bankGetNetResponse": { "required": [ "netPosition" ], "type": "object", "properties": { "warning": { "type": "string" }, "netPosition": { "type": "array", "items": { "type": "object", "properties": { "asOfDate": { "type": "string", "description": "Format date time" }, "bankFunds": { "type": "string" }, "netPosition": { "type": "string" }, "incomingAmount": { "type": "string" }, "outgoingAmount": { "type": "string" }, "upcomingWindow": { "type": "string", "description": "Format date time" }, "currencyAlphaCode": { "type": "string" } } } } }, "description": "Successful request" } } }, "examples": { "Get Net Position by Bank ID": { "summary": "Get Net Position by Bank ID", "value": { "netPosition": [ { "currencyAlphaCode": "USD", "incomingAmount": "2500", "bankFunds": "500", "netPosition": "1000", "upcomingWindow": "2023-11-10 10:00:00 GMT", "asOfDate": "2023-11-09 20:33:31 GMT", "outgoingAmount": "1500" }, { "currencyAlphaCode": "GBP", "incomingAmount": "2500", "bankFunds": "500", "netPosition": "1000", "upcomingWindow": "2023-11-10 10:00:00 GMT", "asOfDate": "2023-11-09 20:33:31 GMT", "outgoingAmount": "1500" }, { "currencyAlphaCode": "INR", "incomingAmount": "2500", "bankFunds": "500", "netPosition": "1000", "upcomingWindow": "2023-11-10 10:00:00 GMT", "asOfDate": "2023-11-09 20:33:31 GMT", "outgoingAmount": "1500" } ] } }, "Get Net Position by Currency": { "summary": "Get Net Position by Currency", "value": { "netPosition": [ { "currencyAlphaCode": "USD", "incomingAmount": "2500", "bankFunds": "500", "netPosition": "1000", "upcomingWindow": "2023-11-10 10:00:00 GMT", "asOfDate": "2023-11-09 20:35:39 GMT", "outgoingAmount": "1500" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "Get Net Position by BID/BIC": { "example": { "errorMessages": [ "BankId/Bic length should be 8 or 11 digits only" ] } }, "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" }, "description": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1banks~1netPosition/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/companies/banks": { "get": { "tags": [ "Bank API" ], "summary": "Return all the companies associated with a bank", "description": "Return all the companies associated with a bank", "operationId": "Return all the companies associated with a bank", "parameters": [ { "name": "bankId", "in": "query", "description": "Visa-issued Business ID (BID) 8 digits OR SWIFT BIC of participant bank. For sandbox testing use bankId = 12345678, 67778901, 89000100, ABDGAU36, BARCGB22", "required": true, "style": "form", "explode": true, "schema": { "maxLength": 11, "minLength": 8, "type": "string" } }, { "name": "keyword", "in": "query", "description": "Can search with anything related to the bank (ID, enterprise ID, IBAN, etc.). For sandbox testing use 'wal' for keyword", "required": false, "style": "form", "explode": true, "schema": { "minLength": 3, "type": "string" } }, { "name": "cursor", "in": "query", "description": "The link the next set of payments (Supports Paganization)", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "reccount", "in": "query", "description": "The number of records that will be displayed", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "bankViewCompaniesPagination": { "required": [ "pagingData" ], "type": "object", "properties": { "nexturl": { "type": "string", "description": "Supports Paganization." }, "endIndex": { "type": "string", "description": "Supports Paganization." }, "pageSize": { "type": "integer", "description": "Supports Paganization.", "format": "int64" }, "nextIndex": { "type": "string", "description": "Supports Paganization." }, "pagingData": { "required": [ "bankId", "blockedCorridors", "companyId", "companyProfile", "lastUpdated", "statusText", "transactionLimits" ], "type": "object", "properties": { "bankId": { "maxLength": 11, "minLength": 8, "type": "string", "description": "Visa issued Business ID (BID) 8-digits." }, "bank_bic": { "maxLength": 11, "minLength": 8, "type": "string", "description": "SWIFT BIC of participant bank." }, "companyId": { "type": "string", "description": "The Company ID used by the Participant to identify the Commercial Customer." }, "statusText": { "type": "string", "description": "Status of the Bank and whether they are Active or not in B2B Connect." }, "lastUpdated": { "type": "string", "description": "Last Synced Date.", "format": "date-time" }, "companyProfile": { "required": [ "address", "bankAccountNumber", "bankRoutingNumber", "businessRegistrationNumber", "chipsUid", "clabe", "corporateLegalName", "defaultCurrencyIsoCode", "doingBusinessAs", "iban", "industryCode", "ownershipDetails", "remitReconcileProfile", "swiftLEI" ], "type": "object", "properties": { "iban": { "maxLength": 34, "type": "string", "description": "The Commercial Customer's IBAN. (Required if bankRoutingNumber, bankAccountNumber, clabe or chipsUid not provided.)" }, "clabe": { "type": "string", "description": "The enrolling Commercial Customer's IBAN number. (Required if bankRoutingNumber, iban, bankAccountNumber or chipsUid not provided.)" }, "taxId": { "type": "string", "description": "The Commercial Customer's local Tax ID." }, "address": { "required": [ "city", "countryDisplayName", "countryIsoCode", "line1", "state", "unitNo", "zipCode" ], "type": "object", "properties": { "city": { "type": "string", "description": "City of the Commercial Customer in question." }, "line1": { "type": "string", "description": "Address of the Commercial Customer in question; except Unit Number." }, "state": { "type": "string", "description": "State of the Commercial Customer in question." }, "unitNo": { "type": "string", "description": "Unit Number of Address field." }, "zipCode": { "type": "string", "description": "Zip code of Commercial Customer in question." }, "countryIsoCode": { "type": "integer", "description": "Valid supported ISO 3166 3-digit numeric country code, based on country of the Commercial Customer's address." }, "countryDisplayName": { "type": "string", "description": "Country of the Commercial Customer based on address." } }, "description": "The complete address for the Commercial Customer in question." }, "chipsUid": { "type": "string", "description": "The enrolling Commercial Customer's Chip UID number. (Required if bankRoutingNumber, iban, clabe or bankAccountNumber not provided.)" }, "swiftLEI": { "type": "string", "description": "The enrolling Commercial Customer's Legal Entity Identifier assigned by SWIFT." }, "enterpriseId": { "type": "string", "description": "Unique identifier automatically assigned to Commercial Customers enabled in the system." }, "industryCode": { "type": "string", "description": "The Commercial Customer's industry category code." }, "industryName": { "type": "string", "description": "The Commercial Customer's industry category." }, "defaultCurrency": { "type": "string", "description": "The currency type that the Commercial Customer is configured to settle in." }, "doingBusinessAs": { "type": "string", "description": "The alternate name the enrolling Commercial Customer operates under." }, "ownershipDetails": { "type": "array", "items": { "type": "object", "properties": { "owners": { "type": "array", "items": { "type": "object", "properties": { "prefix": { "type": "string", "description": "Prefix of the individual or entity with 25% or greater ownership stake in the Commercial Customer." }, "suffix": { "type": "string", "description": "Suffix of the individual with 25% or greater ownership stake in the Commercial Customer." }, "address": { "type": "string", "description": "The full address of the individual or entity." }, "isActive": { "type": "boolean", "description": "Current participation status in the system. Active (the Commercial Customer can send or receive transactions in the system). Not Active (the Commercial Customer is in the system, but cannot send or receive transactions)" }, "lastName": { "type": "string", "description": "Last Name of the individual with 25% or greater ownership stake in the Commercial Customer." }, "firstName": { "type": "string", "description": "First Name of the individual with 25% or greater ownership stake in the Commercial Customer." }, "entityName": { "type": "string", "description": "The name of an entity with 25% or greater ownership stake in the Commercial Customer. (Required if greater than 25% ownership stake)." }, "middleName": { "type": "string", "description": "Middle Name of the individual with 25% or greater ownership stake in the Commercial Customer." }, "isIndividual": { "type": "boolean", "description": "An individual non-corporate owner." }, "countryOfResidence": { "type": "string", "description": "The country of residence of the individual or entity (Valid supported ISO 3166 3-character country code)." }, "countryOfResidenceISO": { "type": "integer", "description": "The country of residence of the individual or entity. (Valid supported ISO 3166 3-digit numeric country code)." }, "nationalityCountryCode": { "type": "string", "description": "The nationality country of the individual or entity (Valid supported ISO 3166 3-character country code)." }, "nationalityCountryCodeISO": { "type": "integer", "description": "The nationality country of the individual or entity. (Valid supported ISO 3166 3-digit numeric country code)." }, "countryOfBusinessRegistrationISO": { "type": "integer", "description": "The country of business registration of the entity (Valid supported ISO 3166 3-digit numeric country code)." } } } }, "prefix": { "type": "string", "description": "Prefix of the individual or entity with 25% or greater ownership stake in the Commercial Customer." }, "suffix": { "type": "string", "description": "Suffix of the individual with 25% or greater ownership stake in the Commercial Customer." }, "address": { "type": "string", "description": "The full address of the individual or entity." }, "isActive": { "type": "boolean", "description": "Current participation status in the system. Active (the Commercial Customer can send or receive transactions in the system). Not Active (the Commercial Customer is in the system, but cannot send or receive transactions)" }, "lastName": { "type": "string", "description": "Last Name of the individual with 25% or greater ownership stake in the Commercial Customer." }, "firstName": { "type": "string", "description": "First Name of the individual with 25% or greater ownership stake in the Commercial Customer." }, "entityName": { "type": "string", "description": "The name of an entity with 25% or greater ownership stake in the Commercial Customer. (Required if greater than 25% ownership stake)." }, "middleName": { "type": "string", "description": "Middle Name of the individual with 25% or greater ownership stake in the Commercial Customer." }, "isIndividual": { "type": "boolean", "description": "An individual non-corporate owner." }, "countryOfResidence": { "type": "string", "description": "The country of residence of the individual or entity (Valid supported ISO 3166 3-character country code)." }, "countryOfResidenceISO": { "type": "integer", "description": "The country of residence of the individual or entity. (Valid supported ISO 3166 3-digit numeric country code)." }, "nationalityCountryCode": { "type": "string", "description": "The nationality country of the individual or entity (Valid supported ISO 3166 3-character country code)." }, "nationalityCountryCodeISO": { "type": "integer", "description": "The nationality country of the individual or entity. (Valid supported ISO 3166 3-digit numeric country code)." }, "countryOfBusinessRegistrationISO": { "type": "integer", "description": "The country of business registration of the entity (Valid supported ISO 3166 3-digit numeric country code)." } } } }, "bankAccountNumber": { "type": "string", "description": "The Commercial Customer's Participant Account Number. (Required if bankRoutingNumber, iban, clabe or chipsUid not provided.)" }, "bankRoutingNumber": { "type": "string", "description": "The Commercial Customer's Participant routing number. (Required if bankAccountNumber, iban, clabe or chipsUid not provided.)" }, "corporateLegalName": { "type": "string", "description": "The Participant that the Commercial Customer is associated within B2B Connect Service." }, "remitReconcileProfile": { "required": [ "reconcileProfile", "remitProfile" ], "type": "object", "properties": { "remitProfile": { "required": [ "attachmentFormat", "deliveryMethod", "email", "frequency" ], "type": "object", "properties": { "email": { "type": "string", "description": "The payment recipient's email." }, "frequency": { "type": "string", "description": "Category of the Frequency that is being requested Potential Values: Every Day , Upon Payment." }, "deliveryMethod": { "type": "string", "description": "The delivery method for remittance information." }, "attachmentFormat": { "type": "string", "description": "The format of the remittance data sent to recipient. Could be CSV, PDF or XLS." } }, "description": "Company's information for remittance." }, "reconcileProfile": { "required": [ "attachmentFormat", "deliveryMethod", "email", "frequency" ], "type": "object", "properties": { "email": { "type": "string", "description": "The payment recipient's email." }, "frequency": { "type": "string", "description": "Category of the Frequency that is being requested Potential Values: Every Day , Upon Payment." }, "deliveryMethod": { "type": "string", "description": "The delivery method for reconciliation information." }, "attachmentFormat": { "type": "string", "description": "The format of the reconciliation data sent to the recipient." } }, "description": "Company's information for reconciling." } }, "description": "Shows the company's information for remittance and reconciliation notifications." }, "defaultCurrencyIsoCode": { "type": "integer", "description": "The currency type that the Commercial Customer is configured to settle in (Valid supported ISO 4217 3-digit numeric country code)." }, "businessRegistrationNumber": { "type": "string", "description": "The Commercial Customer's business registration number." } }, "description": "Shows the number of Commercial Customers enrolled under the participant." }, "blockedCorridors": { "type": "object", "properties": { "blockedCountries": { "type": "array", "items": { "type": "object", "properties": { "blockedDesc": { "type": "string", "description": "Indicates if a country is blocked and what category of entity blocked it. Potential Statuse: visaBlocked, bankBlocked, companyBlocked, unblocked." }, "countryCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "Valid supported ISO 3166 3-character country code." }, "isoCountryCode": { "type": "integer", "description": "Valid supported ISO 3166 3-digit numeric country code." }, "countryDisplayName": { "type": "string", "description": "Name of country." } } } } }, "description": "Shows the countries that have been blocked both at the system and at the participant level." }, "transactionLimits": { "required": [ "customLimits", "dailyVolume", "singleTransaction" ], "type": "object", "properties": { "dailyVolume": { "type": "string", "description": "The maximum amount of funds that can be exchanged across all transactions each day. (Cannot exceed global-level transaction limits)." }, "customLimits": { "type": "boolean", "description": "True if they have set up custom limits. False if they have default limits." }, "singleTransaction": { "type": "string", "description": "The maximum amount of funds that can be exchanged in one transaction." } }, "description": "Shows the default transaction limits (in payment currency) settings for enrolled commercial customers." }, "bankClearingMemberId": { "type": "string", "description": "clearing member id of the non bic debtor agent bank" }, "bankClearingMemberIdType": { "type": "string", "description": "clearing member id type of the non bic debtor agent bank" } }, "description": "Returns Query Results." }, "startIndex": { "type": "string", "description": "Supports Paganization." }, "totalRecords": { "type": "integer", "description": "Supports Paganization.", "format": "int64" }, "remainingRecords": { "type": "string", "description": "Supports Paganization." } }, "description": "Successful request" } } }, "examples": { "Get All Companies by Keyword": { "summary": "Get All Companies by Keyword", "value": { "pagingData": [ { "bankClearingMemberIdType": null, "lastUpdated": "01/02/2017", "bankId": "89000100", "companyId": "39", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "bankBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "statusText": "In Process", "companyProfile": { "chipsUid": "", "industryName": "Transportation/Storage", "address": { "zipCode": "78759", "unitNo": "214", "city": "Austin", "countryIsoCode": 826, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Launs", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "James", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": "James", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "Bond", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 4, "nationalityCountryCodeISO": null, "owners": null, "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity3", "middleName": null }, { "lastName": "SAM", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 5, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 5, "firstName": "Ram", "entityName": null, "middleName": "" } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity2", "middleName": null } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity1", "middleName": null } ], "corporateLegalName": "Walmart", "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "NA", "taxId": "567781911", "defaultCurrency": "EUR", "bankRoutingNumber": "89000034", "businessRegistrationNumber": "892222900", "iban": "US330006100519786457841300", "bankAccountNumber": "9022266912", "enterpriseId": "V-USA-EUR-20990373-100000001-004", "defaultCurrencyIsoCode": 978, "clabe": "457001" }, "transactionLimits": { "customLimits": true, "dailyVolume": "9999999999", "singleTransaction": "250000" }, "bank_bic": "BARCGB22", "bankClearingMemberId": null } ], "startIndex": "49", "totalRecords": 2, "nexturl": "https://vbc-qa-sandbox.visa.com:8443/visab2bconnect/v2/companies/banks?bankId=89000100&keyword=wal&cursor=89&reccount=2", "endIndex": "49", "remainingRecords": "1", "pageSize": 1, "nextIndex": "89" } }, "Get All Companies by Bank ID": { "summary": "Get All Companies by Bank ID", "value": { "pagingData": [ { "bankClearingMemberIdType": null, "lastUpdated": "01/02/2017", "bankId": "67778901", "companyId": "39", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "bankBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "statusText": "In Process", "companyProfile": { "chipsUid": "", "industryName": "Transportation/Storage", "address": { "zipCode": "78759", "unitNo": "214", "city": "Austin", "countryIsoCode": 826, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Launs", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "James", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": "James", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "Bond", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 4, "nationalityCountryCodeISO": null, "owners": null, "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity3", "middleName": null }, { "lastName": "SAM", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 5, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 5, "firstName": "Ram", "entityName": null, "middleName": "" } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity2", "middleName": null } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity1", "middleName": null } ], "corporateLegalName": "HEB", "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "NA", "taxId": "567730011", "defaultCurrency": "EUR", "bankRoutingNumber": "89000887", "businessRegistrationNumber": "344222900", "iban": "US330006100519786457867300", "bankAccountNumber": "9086666911", "enterpriseId": "V-USA-EUR-20990373-100900001-008", "defaultCurrencyIsoCode": 978, "clabe": "457001" }, "transactionLimits": { "customLimits": true, "dailyVolume": "9999999999", "singleTransaction": "250000" }, "bank_bic": "ABDGAU36", "bankClearingMemberId": null } ], "startIndex": "39", "totalRecords": 3, "nexturl": "https://vbc-qa-sandbox.visa.com:8443/visab2bconnect/v2/companies/banks?bankId=67778901&cursor=49&reccount=3", "endIndex": "39", "remainingRecords": "2", "pageSize": 1, "nextIndex": "49" } }, "Get All Companies by Clearing Member ID": { "summary": "Get All Companies by Clearing Member ID", "value": { "pagingData": [ { "bankClearingMemberIdType": "USABA", "lastUpdated": "01/02/2017", "bankId": "12345678", "companyId": "39", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "bankBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "statusText": "In Process", "companyProfile": { "chipsUid": "", "industryName": "Transportation/Storage", "address": { "zipCode": "78759", "unitNo": "214", "city": "Austin", "countryIsoCode": 826, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Launs", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "James", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": "James", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "Bond", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 4, "nationalityCountryCodeISO": null, "owners": null, "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity3", "middleName": null }, { "lastName": "SAM", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 5, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 5, "firstName": "Ram", "entityName": null, "middleName": "" } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity2", "middleName": null } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity1", "middleName": null } ], "corporateLegalName": "HEB", "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "NA", "taxId": "567730011", "defaultCurrency": "EUR", "bankRoutingNumber": "89000887", "businessRegistrationNumber": "344222900", "iban": "US330006100519786457867300", "bankAccountNumber": "9086666911", "enterpriseId": "V-USA-EUR-20990373-100900001-001", "defaultCurrencyIsoCode": 978, "clabe": "457001" }, "transactionLimits": { "customLimits": true, "dailyVolume": "9999999999", "singleTransaction": "250000" }, "bank_bic": null, "bankClearingMemberId": "082900872" } ], "startIndex": "39", "totalRecords": 1, "nexturl": "https://vbc-qa-sandbox.visa.com:8443/visab2bconnect/v2/companies/banks?bankId=12345678&cursor=49&reccount=3", "endIndex": "N/A", "remainingRecords": "N/A", "pageSize": 1, "nextIndex": "N/A" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" }, "description": { "type": "object" } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" }, "description": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1companies~1banks/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/companies": { "post": { "tags": [ "Company API" ], "summary": "Onboard a Company", "description": "Onboard a Company", "operationId": "Onboard a Company", "requestBody": { "content": { "application/json": { "schema": { "required": [ "bankId", "companyId", "companyProfile" ], "type": "object", "properties": { "bankId": { "maxLength": 11, "minLength": 8, "type": "string", "description": "The BID (Visa issued Business ID) (length - 8) or BIC corresponding to BID (lenghth - 8 or 11). for Sandbox testing use BankId = 89000100, 67778901, ABDGAU36, BARCGB22, 12345678" }, "companyId": { "type": "string", "description": "A unique identifier representing a company relationship to a bank." }, "companyProfile": { "required": [ "address", "businessRegistrationNumber", "corporateLegalName", "defaultCurrencyIsoCode", "industryCode" ], "type": "object", "properties": { "iban": { "maxLength": 34, "type": "string", "description": "The Commerical Customer's IBAN. Manadatory if bankAccountNumber, clabe, or chipsUid is not provided" }, "clabe": { "maxLength": 40, "type": "string", "description": "The enrolling Commerical Customer's Clabe number. Manadatory if bankRoutingNumber. iban, bankAccountNumber, or chipsUid is not provided" }, "taxId": { "maxLength": 35, "type": "string" }, "address": { "required": [ "line1" ], "type": "object", "properties": { "city": { "maxLength": 80, "type": "string" }, "line1": { "maxLength": 300, "type": "string", "description": "The address except the unit number all on one line." }, "state": { "maxLength": 80, "type": "string" }, "unitNo": { "maxLength": 20, "type": "string" }, "zipCode": { "maxLength": 50, "type": "string" }, "countryIsoCode": { "minimum": 1, "type": "integer" }, "countryDisplayName": { "maxLength": 20, "type": "string" } } }, "chipsUid": { "maxLength": 40, "type": "string" }, "swiftLEI": { "maxLength": 40, "type": "string" }, "industryCode": { "type": "string" }, "doingBusinessAs": { "maxLength": 80, "type": "string" }, "ownershipDetails": { "type": "array", "items": { "type": "object", "properties": { "prefix": { "maxLength": 40, "type": "string" }, "suffix": { "maxLength": 40, "type": "string" }, "address": { "type": "string" }, "isActive": { "type": "boolean" }, "lastName": { "maxLength": 40, "type": "string" }, "firstName": { "maxLength": 40, "type": "string" }, "entityName": { "maxLength": 40, "type": "string" }, "middleName": { "maxLength": 40, "type": "string" }, "isIndividual": { "type": "boolean" }, "countryOfResidence": { "maxLength": 40, "type": "string" }, "countryOfResidenceISO": { "minimum": 1, "type": "integer" }, "nationalityCountryCode": { "maxLength": 40, "type": "string" }, "nationalityCountryCodeISO": { "minimum": 1, "type": "integer" }, "countryOfBusinessRegistrationISO": { "minimum": 1, "type": "integer" } } } }, "bankAccountNumber": { "maxLength": 40, "type": "string", "description": "The Commercial Customer's Participant Account Number. Mandatory if bankRoutingNumber, iban, clabe, or chipsUid is not provided." }, "bankRoutingNumber": { "maxLength": 40, "type": "string", "description": "The Commerical Customer's Participant routing number. Mandatory if bankAccountNumber, iban, clabe, or chipsUid is not provided" }, "corporateLegalName": { "maxLength": 80, "type": "string", "description": "The complete legal name for the enrolling company" }, "remitReconcileProfile": { "type": "object", "properties": { "remitProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } }, "reconcileProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } } } }, "defaultCurrencyIsoCode": { "minimum": 1, "type": "integer" }, "businessRegistrationNumber": { "maxLength": 40, "type": "string" } } }, "blockedCorridors": { "type": "object", "properties": { "blockedCountries": { "type": "array", "items": { "type": "object", "properties": { "blockedDesc": { "type": "string", "description": "Indicates if a country is blocked and what category of entity blocked it. Statuses are: visaBlocked, bankBlocked, companyBlocked and unblocked." }, "countryCode": { "type": "string" }, "isoCountryCode": { "type": "integer" }, "countryDisplayName": { "type": "string" } } } } } }, "transactionLimits": { "required": [ "dailyVolume", "singleTransaction" ], "type": "object", "properties": { "dailyVolume": { "type": "string", "description": "Daily aggregate transaction volume amount to be applied to the enrolling company." }, "customLimits": { "type": "boolean", "description": "True is specified by the entity in question, false if inherited." }, "singleTransaction": { "type": "string", "description": "Single transaction limit amount to be applied to the enrolling company." } } } } }, "examples": { "Onboard Company by Bank BIC": { "summary": "Onboard Company by Bank BIC", "value": { "bankId": "67778901", "companyId": "39", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "companyBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "companyProfile": { "chipsUid": "", "industryName": "Business Services", "address": { "zipCode": "1234", "unitNo": "1234", "city": "xyz", "countryIsoCode": 840, "state": "xvz", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Eric", "nationalityCountryCode": "USA", "prefix": "l", "ownerIndividualId": null, "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 840, "owners": null, "isIndividual": true, "suffix": "s", "isActive": true, "countryOfResidence": "USA", "ownershipId": "", "countryOfResidenceISO": 840, "firstName": "JOhn", "entityOwnerID": null, "middleName": "Doe" } ], "corporateLegalName": "Failed-20thIndividual90", "industryCode": "01", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "1234", "taxId": 699643099792, "defaultCurrency": "USD", "businessRegistrationNumber": "1234", "iban": null, "bankAccountNumber": "123456", "defaultCurrencyIsoCode": 840, "clabe": "" }, "transactionLimits": { "customLimits": true, "dailyVolume": 500000, "singleTransaction": 12000 } } }, "Onboard a Company by Clearing Member ID": { "summary": "Onboard a Company by Clearing Member ID", "value": { "bankId": "12345678", "companyId": "9999", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "isoCountryCode": 4 } ] }, "companyProfile": { "chipsUid": "", "address": { "zipCode": "78727", "unitNo": "214", "city": "Austin", "countryIsoCode": 344, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": null }, "ownershipDetails": [ { "lastName": "CC", "address": "USA", "nationalityCountryCode": 4, "prefix": "MR", "countryOfBusinessRegistrationISO": 4, "nationalityCountryCodeISO": 356, "owners": null, "isIndividual": false, "suffix": "PHD", "isActive": false, "countryOfResidence": null, "countryOfResidenceISO": 356, "firstName": "AA", "entityName": "E1", "middleName": "BB" } ], "corporateLegalName": "currency2", "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "Email", "attachmentFormat": "PDF", "email": "absc@xyz.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "Email", "attachmentFormat": "PDF", "email": "absc@xyz.com", "frequency": "Every day" } }, "doingBusinessAs": "VDP", "taxId": "19191991", "bankRoutingNumber": "191919191", "businessRegistrationNumber": "1991991", "iban": null, "bankAccountNumber": "119191991", "enterpriseId": "V-USA-EUR-91211-0146", "defaultCurrencyIsoCode": 840, "clabe": "101991919" }, "transactionLimits": { "customLimits": true, "dailyVolume": 90, "singleTransaction": 9 } } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "companyAddResponse": { "required": [ "bankId", "companyId", "companyProfile", "transactionLimits" ], "type": "object", "properties": { "bankId": { "maxLength": 8, "type": "string", "description": "The BID (Visa issued Business ID) of the bank." }, "bank_bic": { "type": "string", "description": "BIC corresponding to the bank" }, "companyId": { "type": "string", "description": "A unique identifier representing a company relationship to a bank." }, "statusText": { "type": "string" }, "lastUpdated": { "type": "string" }, "companyProfile": { "required": [ "address", "businessRegistrationNumber", "corporateLegalName", "defaultCurrencyIsoCode", "industryCode" ], "type": "object", "properties": { "iban": { "type": "string", "description": "The Commerical Customer's IBAN. Mandatory if bankAccountNumber, clabe, or chipsUid is not provided" }, "clabe": { "type": "string", "description": "The enrolling Comerical Customer's Clabe number. Manadatory if bankRoutingNumber, iban, bankAccountNumber, or chipsUid is not provided" }, "taxId": { "type": "string" }, "address": { "required": [ "line1" ], "type": "object", "properties": { "city": { "type": "string" }, "line1": { "type": "string", "description": "The address except the unit number all on one line." }, "state": { "type": "string" }, "unitNo": { "type": "string" }, "zipCode": { "type": "string" }, "countryIsoCode": { "type": "integer" }, "countryDisplayName": { "type": "string" } } }, "chipsUid": { "type": "string" }, "swiftLEI": { "type": "string" }, "enterpriseId": { "type": "string" }, "industryCode": { "type": "string" }, "industryName": { "type": "string" }, "defaultCurrency": { "type": "string" }, "doingBusinessAs": { "type": "string" }, "ownershipDetails": { "type": "array", "items": { "type": "object", "properties": { "prefix": { "type": "string" }, "suffix": { "type": "string" }, "address": { "type": "string" }, "isActive": { "type": "boolean" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "entityName": { "type": "string" }, "middleName": { "type": "string" }, "isIndividual": { "type": "boolean" }, "countryOfResidence": { "type": "string" }, "countryOfResidenceISO": { "type": "integer" }, "nationalityCountryCode": { "type": "string" }, "nationalityCountryCodeISO": { "type": "integer" }, "countryOfBusinessRegistrationISO": { "type": "integer" } } } }, "bankAccountNumber": { "type": "string", "description": "The Commercial Customer's Participant Account Number. Mandatory if bankRoutingNumber, iban, clabe, or chipsUid is not provided" }, "bankRoutingNumber": { "type": "string", "description": "The Commerical Customer's Participant routing number. Mnadatory if bankAccountNumber, iban, clabe, or chipsUid is not provided" }, "corporateLegalName": { "type": "string", "description": "The complete legal name for the enrolling company" }, "remitReconcileProfile": { "type": "object", "properties": { "remitProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } }, "reconcileProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } } } }, "defaultCurrencyIsoCode": { "type": "integer" }, "businessRegistrationNumber": { "type": "string" } } }, "blockedCorridors": { "type": "object", "properties": { "blockedCountries": { "type": "array", "items": { "type": "object", "properties": { "blockedDesc": { "type": "string", "description": "Indicates if a country is blocked and what category of entity blocked it. Statuses are: visaBlocked, bankBlocked, companyBlocked and unblocked." }, "countryCode": { "type": "string" }, "isoCountryCode": { "type": "integer" }, "countryDisplayName": { "type": "string" } } } } } }, "transactionLimits": { "required": [ "dailyVolume", "singleTransaction" ], "type": "object", "properties": { "dailyVolume": { "type": "string", "description": "Daily aggregate transaction volume amount to be applied to the enrolling company." }, "customLimits": { "type": "boolean", "description": "True is specified by the entity in question, false if inherited." }, "singleTransaction": { "type": "string", "description": "Single transaction limit amount to be applied to the enrolling company." } } }, "bankClearingMemberId": { "type": "string", "description": "clearing member id of the corresponding non bic associated debtor agent bank" }, "bankClearingMemberIdType": { "type": "string", "description": "clearing member id type of the corresponding non bic associated debtor agent bank" } }, "description": "Save provided company information and receive a response with the full record information returned." } } }, "examples": { "Onboard Company by Bank BIC": { "summary": "Onboard Company by Bank BIC", "value": { "bankClearingMemberIdType": null, "lastUpdated": "02/01/2024", "bankId": "67778901", "companyId": "1000", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "visaBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "visaBlocked", "countryCode": "ALB", "isoCountryCode": 8, "countryDisplayName": "ALBANIA" }, { "blockedDesc": "visaBlocked", "countryCode": "ASM", "isoCountryCode": 16, "countryDisplayName": "AMERICAN SAMOA" }, { "blockedDesc": "visaBlocked", "countryCode": "AUT", "isoCountryCode": 40, "countryDisplayName": "AUSTRIA" }, { "blockedDesc": "visaBlocked", "countryCode": "BRB", "isoCountryCode": 16, "countryDisplayName": "BARBADOS" }, { "blockedDesc": "visaBlocked", "countryCode": "ALA", "isoCountryCode": 248, "countryDisplayName": "ALAND ISLANDS" }, { "blockedDesc": "visaBlocked", "countryCode": "ABW", "isoCountryCode": 533, "countryDisplayName": "ARUBA" } ] }, "statusText": "ACTIVE", "companyProfile": { "chipsUid": "", "industryName": "Transportation/Storage", "address": { "zipCode": "7", "unitNo": "214", "city": "NewYork", "countryIsoCode": 840, "state": "NewYork", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "C", "address": null, "nationalityCountryCode": null, "prefix": "Miss", "countryOfBusinessRegistrationISO": 4, "nationalityCountryCodeISO": 356, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 356, "firstName": "A", "entityName": null, "middleName": "B" } ], "corporateLegalName": "VDPTEST", "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "CSV", "email": "absc@xyz.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "absc@xyz.com", "frequency": "Every day" } }, "doingBusinessAs": "VDP", "taxId": "19191991", "defaultCurrency": null, "bankRoutingNumber": "191919191", "businessRegistrationNumber": "1991991", "iban": null, "bankAccountNumber": "119191991", "enterpriseId": "V-USA-EUR-10080373-100000001-001", "defaultCurrencyIsoCode": 840, "clabe": "101991919" }, "transactionLimits": { "customLimits": true, "dailyVolume": "9990", "singleTransaction": "25" }, "bank_bic": "ABDGAU36", "bankClearingMemberId": null } }, "Onboard a Company by Clearing Member ID": { "summary": "Onboard a Company by Clearing Member ID", "value": { "bankClearingMemberIdType": "USABA", "lastUpdated": "06/04/2024", "bankId": "12345678", "companyId": "9999", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "visaBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "visaBlocked", "countryCode": "ALB", "isoCountryCode": 8, "countryDisplayName": "ALBANIA" }, { "blockedDesc": "visaBlocked", "countryCode": "ASM", "isoCountryCode": 16, "countryDisplayName": "AMERICAN SAMOA" }, { "blockedDesc": "visaBlocked", "countryCode": "AUT", "isoCountryCode": 40, "countryDisplayName": "AUSTRIA" }, { "blockedDesc": "visaBlocked", "countryCode": "BRB", "isoCountryCode": 16, "countryDisplayName": "BARBADOS" }, { "blockedDesc": "visaBlocked", "countryCode": "ALA", "isoCountryCode": 248, "countryDisplayName": "ALAND ISLANDS" }, { "blockedDesc": "visaBlocked", "countryCode": "ABW", "isoCountryCode": 533, "countryDisplayName": "ARUBA" } ] }, "statusText": "ACTIVE", "companyProfile": { "chipsUid": "", "industryName": "Transportation/Storage", "address": { "zipCode": "78727", "unitNo": "214", "city": "Austin", "countryIsoCode": 344, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": null }, "ownershipDetails": [ { "lastName": "CC", "address": "USA", "nationalityCountryCode": "4", "prefix": "MR", "countryOfBusinessRegistrationISO": 4, "nationalityCountryCodeISO": 356, "owners": null, "isIndividual": false, "suffix": "PHD", "isActive": false, "countryOfResidence": null, "countryOfResidenceISO": 356, "firstName": "AA", "entityName": "E1", "middleName": "BB" } ], "corporateLegalName": "currency2", "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "Email", "attachmentFormat": "PDF", "email": "absc@xyz.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "Email", "attachmentFormat": "PDF", "email": "absc@xyz.com", "frequency": "Every day" } }, "doingBusinessAs": "VDP", "taxId": "19191991", "defaultCurrency": null, "bankRoutingNumber": "191919191", "businessRegistrationNumber": "1991991", "iban": null, "bankAccountNumber": "119191991", "enterpriseId": "V-USA-EUR-10080373-100000001-001", "defaultCurrencyIsoCode": 840, "clabe": "101991919" }, "transactionLimits": { "customLimits": true, "dailyVolume": "90", "singleTransaction": "9" }, "bank_bic": null, "bankClearingMemberId": "082900872" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } } } } } } } }, "x-codegen-request-body-name": "companyAddBody", "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1companies/post", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/companies/{enterpriseId}": { "put": { "tags": [ "Company API" ], "summary": "Edit the information for a company", "description": "Edit the information for a company", "operationId": "Edit the information for a company", "parameters": [ { "name": "enterpriseId", "in": "path", "required": true, "style": "simple", "explode": false, "schema": { "maxLength": 32, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "bankId" ], "type": "object", "properties": { "bankId": { "maxLength": 11, "minLength": 8, "type": "string", "description": "The BID (Visa issued Business ID) (length - 8) or BIC corresponding to BID (lenghth - 8 or 11)" }, "companyId": { "type": "string", "description": "A unique identifier representing a company relationship to a bank." }, "companyProfile": { "type": "object", "properties": { "iban": { "maxLength": 34, "type": "string" }, "clabe": { "maxLength": 40, "type": "string" }, "taxId": { "maxLength": 35, "type": "string" }, "address": { "type": "object", "properties": { "city": { "maxLength": 80, "type": "string" }, "line1": { "maxLength": 300, "type": "string", "description": "The address except the unit number all on one line." }, "state": { "maxLength": 80, "type": "string" }, "unitNo": { "maxLength": 20, "type": "string" }, "zipCode": { "maxLength": 50, "type": "string" }, "countryIsoCode": { "minimum": 1, "type": "integer" }, "countryDisplayName": { "maxLength": 20, "type": "string" } } }, "chipsUid": { "maxLength": 40, "type": "string" }, "swiftLEI": { "maxLength": 40, "type": "string" }, "industryCode": { "type": "string" }, "doingBusinessAs": { "maxLength": 80, "type": "string" }, "ownershipDetails": { "type": "array", "items": { "type": "object", "properties": { "prefix": { "maxLength": 40, "type": "string" }, "suffix": { "maxLength": 40, "type": "string" }, "address": { "type": "string" }, "isActive": { "type": "boolean" }, "lastName": { "maxLength": 40, "type": "string" }, "firstName": { "maxLength": 40, "type": "string" }, "entityName": { "maxLength": 40, "type": "string" }, "middleName": { "maxLength": 40, "type": "string" }, "isIndividual": { "type": "boolean" }, "countryOfResidence": { "maxLength": 40, "type": "string" }, "countryOfResidenceISO": { "minimum": 1, "type": "integer" }, "nationalityCountryCode": { "maxLength": 40, "type": "string" }, "nationalityCountryCodeISO": { "minimum": 1, "type": "integer" }, "countryOfBusinessRegistrationISO": { "minimum": 1, "type": "integer" } } } }, "bankAccountNumber": { "maxLength": 40, "type": "string" }, "bankRoutingNumber": { "maxLength": 40, "type": "string" }, "corporateLegalName": { "maxLength": 80, "type": "string", "description": "The complete legal name for the enrolling company" }, "remitReconcileProfile": { "type": "object", "properties": { "remitProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } }, "reconcileProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } } } }, "defaultCurrencyIsoCode": { "minimum": 1, "type": "integer" }, "businessRegistrationNumber": { "maxLength": 40, "type": "string" } } }, "blockedCorridors": { "type": "object", "properties": { "blockedCountries": { "type": "array", "items": { "type": "object", "properties": { "blockedDesc": { "type": "string", "description": "Indicates if a country is blocked and what category of entity blocked it. Statuses are: visaBlocked, bankBlocked, companyBlocked and unblocked." }, "countryCode": { "type": "string" }, "isoCountryCode": { "type": "integer" }, "countryDisplayName": { "type": "string" } } } } } }, "transactionLimits": { "type": "object", "properties": { "dailyVolume": { "type": "string", "description": "Daily aggregate transaction volume amount to be applied to the enrolling company." }, "customLimits": { "type": "boolean", "description": "True is specified by the entity in question, false if inherited." }, "singleTransaction": { "type": "string", "description": "Single transaction limit amount to be applied to the enrolling company." } } } } }, "examples": { "Edit Company by BIC": { "summary": "Edit Company by BIC", "value": { "bankId": "67778901", "companyId": "39", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "bankBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "statusText": "In Process", "companyProfile": { "chipsUid": "", "industryName": "Utilities", "address": { "zipCode": "78759", "unitNo": "214", "city": "Austin", "countryIsoCode": 826, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Kate", "address": "New York", "nationalityCountryCode": "ALA", "percentageOwnership": 26, "nationalityCountryCodeISO": 248, "isIndividual": true, "isActive": true, "countryOfResidence": "ALA", "ownerIndividuals": [ { "countryOfResidenceISO": 8, "lastName": "Doe", "firstName": "John", "address": "Austin - TX", "prefix": "L", "percentageOwnership": 26, "nationalityCountryCodeISO": 8, "middleName": "", "suffix": "", "isActive": true, "countryOfResidenceName": "ALBANIA", "nationalityCountryName": "ALBANIA" } ], "countryOfResidenceISO": 248, "firstName": "Lacey", "entityOwner": "John Young", "entityName": "TestEntity s", "email": "lacey@gmail.com" } ], "corporateLegalName": "HEB", "secondaryContact": { "phone": "5123459757", "jobTitle": "Director", "name": "Alan Lipton", "email": "alipton@gmail.com" }, "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johnnydoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "NA", "taxId": "567781944", "defaultCurrency": "EUR", "bankRoutingNumber": "89000034", "businessRegistrationNumber": "892222111", "iban": null, "primaryContact": { "phone": "4768", "jobTitle": "SW", "name": "Joe Joseph", "email": "joe@gmail.com" }, "bankAccountNumber": "9022212222", "enterpriseId": "V-USA-EUR-20990373-100900001-001", "defaultCurrencyIsoCode": 978, "clabe": "456912000000000000" }, "transactionLimits": { "customLimits": true, "dailyVolume": 9999999999, "singleTransaction": 250000 } } }, "Edit Company by Clearing Member ID": { "summary": "Edit Company by Clearing Member ID", "value": { "bankId": "12345678", "companyId": "39", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "bankBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "statusText": "In Process", "companyProfile": { "chipsUid": "", "industryName": "Utilities", "address": { "zipCode": "78759", "unitNo": "214", "city": "Austin", "countryIsoCode": 826, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Kate", "address": "New York", "nationalityCountryCode": "ALA", "percentageOwnership": 26, "nationalityCountryCodeISO": 248, "isIndividual": true, "isActive": true, "countryOfResidence": "ALA", "ownerIndividuals": [ { "countryOfResidenceISO": 8, "lastName": "Doe", "firstName": "John", "address": "Austin - TX", "prefix": "L", "percentageOwnership": 26, "nationalityCountryCodeISO": 8, "middleName": "", "suffix": "", "isActive": true, "countryOfResidenceName": "ALBANIA", "nationalityCountryName": "ALBANIA" } ], "countryOfResidenceISO": 248, "firstName": "Lacey", "entityOwner": "John Young", "entityName": "TestEntity s", "email": "lacey@gmail.com" } ], "corporateLegalName": "HEB", "secondaryContact": { "phone": "5123459757", "jobTitle": "Director", "name": "Alan Lipton", "email": "alipton@gmail.com" }, "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johnnydoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "NA", "taxId": "567781944", "defaultCurrency": "EUR", "bankRoutingNumber": "89000034", "businessRegistrationNumber": "892222111", "iban": null, "primaryContact": { "phone": "4768", "jobTitle": "SW", "name": "Joe Joseph", "email": "joe@gmail.com" }, "bankAccountNumber": "9022212222", "enterpriseId": "V-USA-EUR-20990373-100900001-001", "defaultCurrencyIsoCode": 978, "clabe": "456912000000000000" }, "transactionLimits": { "customLimits": true, "dailyVolume": 9999999999, "singleTransaction": 250000 } } } } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "companyEditResponse": { "type": "object", "properties": { "bankId": { "maxLength": 8, "type": "string", "description": "The BID (Visa issued Business ID) of the bank." }, "bank_bic": { "type": "string", "description": "BIC corresponding to the bank" }, "companyId": { "type": "string", "description": "A unique identifier representing a company relationship to a bank." }, "statusText": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "companyProfile": { "type": "object", "properties": { "iban": { "type": "string" }, "clabe": { "type": "string" }, "taxId": { "type": "string" }, "address": { "type": "object", "properties": { "city": { "type": "string" }, "line1": { "type": "string", "description": "The address except the unit number all on one line." }, "state": { "type": "string" }, "unitNo": { "type": "string" }, "zipCode": { "type": "string" }, "countryIsoCode": { "type": "integer" }, "countryDisplayName": { "type": "string" } } }, "chipsUid": { "type": "string" }, "swiftLEI": { "type": "string" }, "enterpriseId": { "type": "string", "description": "For Sandbox testing use enterpriseId as V-USA-EUR-20990373-100900001-008" }, "industryCode": { "type": "string" }, "industryName": { "type": "string" }, "defaultCurrency": { "type": "string" }, "doingBusinessAs": { "type": "string" }, "ownershipDetails": { "type": "array", "items": { "type": "object", "properties": { "prefix": { "type": "string" }, "suffix": { "type": "string" }, "address": { "type": "string" }, "isActive": { "type": "boolean" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "entityName": { "type": "string" }, "middleName": { "type": "string" }, "isIndividual": { "type": "boolean" }, "countryOfResidence": { "type": "string" }, "countryOfResidenceISO": { "type": "integer" }, "nationalityCountryCode": { "type": "string" }, "nationalityCountryCodeISO": { "type": "integer" }, "countryOfBusinessRegistrationISO": { "type": "integer" } } } }, "bankAccountNumber": { "type": "string" }, "bankRoutingNumber": { "type": "string" }, "corporateLegalName": { "type": "string", "description": "The complete legal name for the enrolling company" }, "remitReconcileProfile": { "type": "object", "properties": { "remitProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } }, "reconcileProfile": { "type": "object", "properties": { "email": { "type": "string" }, "frequency": { "type": "string" }, "deliveryMethod": { "type": "string", "description": "The delivery method" }, "attachmentFormat": { "type": "string" } } } } }, "defaultCurrencyIsoCode": { "type": "integer" }, "businessRegistrationNumber": { "type": "string" } } }, "blockedCorridors": { "type": "object", "properties": { "blockedCountries": { "type": "array", "items": { "type": "object", "properties": { "blockedDesc": { "type": "string", "description": "Indicates if a country is blocked and what category of entity blocked it. Statuses are: visaBlocked, bankBlocked, companyBlocked and unblocked." }, "countryCode": { "type": "string" }, "isoCountryCode": { "type": "integer" }, "countryDisplayName": { "type": "string" } } } } } }, "transactionLimits": { "type": "object", "properties": { "dailyVolume": { "type": "string", "description": "Daily aggregate transaction volume amount to be applied to the enrolling company." }, "customLimits": { "type": "boolean", "description": "True is specified by the entity in question, false if inherited." }, "singleTransaction": { "type": "string", "description": "Single transaction limit amount to be applied to the enrolling company." } } }, "bankClearingMemberId": { "type": "string", "description": "The clearing member id of the non bic asociated debtor bank" }, "bankClearingMemberIdType": { "type": "string", "description": "The clearing member id type of the non bic asociated debtor bank" } }, "description": "Successful request" } } }, "examples": { "Edit Company by BIC": { "summary": "Edit Company by BIC", "value": { "bankClearingMemberIdType": null, "lastUpdated": "12/01/2023", "bankId": "67778901", "companyId": "1234569", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "bankBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "statusText": "In Process", "companyProfile": { "chipsUid": "", "industryName": "Transportation/Storage", "address": { "zipCode": "Editzipcode4477", "unitNo": "214", "city": "Herndon", "countryIsoCode": 840, "state": "Texas", "line1": "12219 Leesburg ", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Launs", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "James", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": "James", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 8, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 8, "firstName": "Bond", "entityName": null, "middleName": "" }, { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 8, "nationalityCountryCodeISO": null, "owners": [ { "lastName": null, "address": "Austin", "nationalityCountryCode": null, "prefix": null, "countryOfBusinessRegistrationISO": 4, "nationalityCountryCodeISO": null, "owners": null, "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity3", "middleName": null }, { "lastName": "SAM", "address": null, "nationalityCountryCode": null, "prefix": "", "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 5, "owners": null, "isIndividual": true, "suffix": "", "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": 5, "firstName": "Ram", "entityName": null, "middleName": "" } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity2", "middleName": null } ], "isIndividual": false, "suffix": null, "isActive": true, "countryOfResidence": null, "countryOfResidenceISO": null, "firstName": null, "entityName": "Entity1", "middleName": null } ], "corporateLegalName": "company for testing", "industryCode": null, "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "NA", "taxId": "567730011", "defaultCurrency": "EUR", "bankRoutingNumber": "89000887", "businessRegistrationNumber": "344222900", "iban": "US330006100519786457867300", "bankAccountNumber": "9086666911", "enterpriseId": "V-USA-EUR-20990373-100900001-008", "defaultCurrencyIsoCode": 36, "clabe": "457001" }, "transactionLimits": { "customLimits": true, "dailyVolume": "9999999999", "singleTransaction": "250000" }, "bank_bic": "ABDGAU36", "bankClearingMemberId": null } }, "Edit Company by Clearing Member ID": { "summary": "Edit Company by Clearing Member ID", "value": { "bankClearingMemberIdType": "USABA", "lastUpdated": "02/06/2024", "bankId": "12345678", "companyId": "39", "blockedCorridors": { "blockedCountries": [ { "blockedDesc": "companyBlocked", "countryCode": "AFG", "isoCountryCode": 4, "countryDisplayName": "AFGHANISTAN" }, { "blockedDesc": "bankBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "Cuba" } ] }, "statusText": "In Process", "companyProfile": { "chipsUid": "", "industryName": "Utilities", "address": { "zipCode": "78759", "unitNo": "214", "city": "Austin", "countryIsoCode": 826, "state": "Texas", "line1": "Research Blvd", "countryDisplayName": "USA" }, "ownershipDetails": [ { "lastName": "Kate", "address": "New York", "nationalityCountryCode": "ALA", "prefix": null, "countryOfBusinessRegistrationISO": null, "nationalityCountryCodeISO": 248, "owners": null, "isIndividual": true, "suffix": null, "isActive": true, "countryOfResidence": "ALA", "countryOfResidenceISO": 248, "firstName": "Lacey", "entityName": null, "middleName": null } ], "corporateLegalName": "HEB", "industryCode": "22", "swiftLEI": "", "remitReconcileProfile": { "reconcileProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johnnydoe@visa.com", "frequency": "Every day" }, "remitProfile": { "deliveryMethod": "email", "attachmentFormat": "PDF", "email": "johndoe@visa.com", "frequency": "Every day" } }, "doingBusinessAs": "NA", "taxId": "567781944", "defaultCurrency": "EUR", "bankRoutingNumber": "89000034", "businessRegistrationNumber": "892222111", "iban": "US330006100519786457867300", "bankAccountNumber": "9022212222", "enterpriseId": "V-USA-EUR-20990373-100900001-001", "defaultCurrencyIsoCode": 978, "clabe": "456912000000000000" }, "transactionLimits": { "customLimits": true, "dailyVolume": "9999999999", "singleTransaction": "250000" }, "bank_bic": "", "bankClearingMemberId": "082900872" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } } } } } } } }, "x-codegen-request-body-name": "companyEditPutBody", "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1companies~1{enterpriseId}/put", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/payments": { "post": { "tags": [ "Payments API" ], "summary": "Make a Payment", "description": "Make a Payment.", "operationId": "Make a Payment", "parameters": [ { "name": "relationship-id", "in": "header", "description": "subsidiary Clearing MemberID OR subsidiary Bank Bic", "required": false, "explode": false, "schema": { "type": "string", "format": "BIC" } } ], "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/companyPaymentsRequest_13" }, "examples": { "Make Payment by Clearing Member ID": { "summary": "Make Payment by Clearing Member ID", "value": { "chargeBearer": "SHAR", "structuredRemittance": [ { "invoiceNotes": "Payment as agreed", "invoiceNumber": "1", "poNumber": "12345", "partialPayment": false } ], "creditorAgentBranchName": "Test", "loanReferenceNumber": "LRN1234567890", "debtorEnterpriseId": "V-BRA-CCC-57987557-100676596-001", "creditorAccountNumber": "254606", "creditorAgentInstruction": "testpayment", "debtorAgentClearingMemberIDType": "USABA", "endToEndID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYUH", "serviceLevel": "STANDARD", "creditorEnterpriseId": "V-USA-USD-CBWBUS44XXX-100700060-001", "transactionID": "BD9ISCA5KFGHGGHDGHJBG4KQY6P", "unstructuredRemittance": "testpayment", "instructedCurrency": "MXN", "creditorLEI": "529900T8BM49AURSDO55", "fxTradeRefNumber": "9b399c7a785545a3863302eae9b7dddb", "creditorAgentClearingMemberID": "546493222", "instructedAmount": "1.64", "paymentPurpose": "Exportbills", "creditorAgentBic": "CBWBUS44XXX", "debtorAgentClearingMemberID": "062001186", "valueAddedTaxIndicator": "INC", "creditorTaxID": "12345", "creditorAgentBranchID": "12345" } }, "Make Payment by Bank BIC": { "summary": "Make Payment by Bank BIC", "value": { "chargeBearer": "SHAR", "structuredRemittance": [ { "invoiceNotes": "Payment as agreed", "invoiceNumber": "1", "poNumber": "12345", "partialPayment": false } ], "creditorAgentBranchName": "Test", "loanReferenceNumber": "LRN1234567890", "debtorEnterpriseId": "V-BRA-CCC-57987557-100676596-001", "creditorAccountNumber": "254606", "creditorAgentInstruction": "testpayment", "endToEndID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYUH", "serviceLevel": "STANDARD", "creditorEnterpriseId": "V-USA-USD-CBWBUS44XXX-100700060-001", "transactionID": "BD9ISCA5KFGHGGHDGHJBG4KQY6P", "unstructuredRemittance": "testpayment", "instructedCurrency": "MXN", "creditorLEI": "529900T8BM49AURSDO55", "fxTradeRefNumber": "9b399c7a785545a3863302eae9b7dddb", "creditorAgentClearingMemberID": "546493222", "instructedAmount": "1.64", "paymentPurpose": "Exportbills", "creditorAgentBic": "CBWBUS44XXX", "debtorAgentBic": "BARCGB22", "valueAddedTaxIndicator": "INC", "creditorTaxID": "12345", "creditorAgentBranchID": "12345" } } } } }, "required": true }, "responses": { "201": { "description": "Payment created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/companyPaymentsResponse_13" }, "examples": { "Make Payment by Clearing Member ID": { "summary": "Make Payment by Clearing Member ID", "value": { "chargeBearer": "SHAR", "structuredRemittance": [ { "invoiceNotes": "Payment as agreed", "invoiceNumber": "1", "poNumber": "12345", "partialPayment": false } ], "creditorAgentBranchName": "Test", "loanReferenceNumber": "LRN1234567890", "debtorEnterpriseId": "V-BRA-CCC-57987557-100676596-001", "expectedSettlementDate": "2019-07-23", "type": "In Network", "creditorEnterpriseId": "V-USA-USD-CBWBUS44XXX-100700060-001", "transactionID": "BD9ISCA5KFGHGGHDGHJBG4KQY6P", "unstructuredRemittance": "testpayment", "instructedCurrency": "MXN", "exchangeRate": 1, "paymentId": "48509789", "creditorLEI": "529900T8BM49AURSDO55", "fxTradeRefNumber": "9b399c7a785545a3863302eae9b7dddb", "paymentCreatedDate": "2019-07-23", "instructedAmount": 1.64, "debtorAgentClearingMemberID": "062001186", "paymentStatus": "Pending Settlement", "creditorAgentBranchID": "12345", "creditorAccountNumber": "254606", "creditorAgentInstruction": "testpayment", "debtorAgentClearingMemberIDType": "USABA", "endToEndID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYUH", "serviceLevel": "STANDARD", "settlementCurrency": "MXN", "creditorAgentClearingMemberID": "546493222", "responseList": [ { "reasonCode": "Z200", "reasonDesc": " Payment Processing successful." } ], "paymentPurpose": "Exportbills", "creditorAgentBic": "CBWBUS44XXX", "settlementAmount": 1.64, "valueAddedTaxIndicator": "INC", "creditorTaxID": "12345" } }, "Make Payment by Bank BIC": { "summary": "Make Payment by Bank BIC", "value": { "chargeBearer": "SHAR", "structuredRemittance": [ { "invoiceNotes": "Payment as agreed", "invoiceNumber": "1", "poNumber": "12345", "partialPayment": false } ], "creditorAgentBranchName": "Test", "loanReferenceNumber": "LRN1234567890", "debtorEnterpriseId": "V-BRA-CCC-57987557-100676596-001", "expectedSettlementDate": "2019-07-23", "type": "In Network", "creditorEnterpriseId": "V-USA-USD-CBWBUS44XXX-100700060-001", "transactionID": "BD9ISCA5KFGHGGHDGHJBG4KQY6P", "unstructuredRemittance": "testpayment", "instructedCurrency": "MXN", "exchangeRate": 1, "paymentId": "40855374", "creditorLEI": "529900T8BM49AURSDO55", "fxTradeRefNumber": "9b399c7a785545a3863302eae9b7dddb", "paymentCreatedDate": "2019-07-23", "instructedAmount": 1.64, "paymentStatus": "Pending Settlement", "creditorAgentBranchID": "12345", "creditorAccountNumber": "254606", "creditorAgentInstruction": "testpayment", "endToEndID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYUH", "serviceLevel": "STANDARD", "settlementCurrency": "MXN", "creditorAgentClearingMemberID": "546493222", "responseList": [ { "reasonCode": "Z200", "reasonDesc": " Payment Processing successful." } ], "paymentPurpose": "Exportbills", "creditorAgentBic": "CBWBUS44XXX", "settlementAmount": 1.64, "debtorAgentBic": "BARCGB22XXX", "valueAddedTaxIndicator": "INC", "creditorTaxID": "12345" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseList_13" } } } }, "500": { "description": "Server Error or Exception", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseMessage_13" } } } } }, "x-operationVersions": [ { "label": "v1", "operationPointer": "#/paths/~1visab2bconnect~1v1~1payments/post", "default": false } ], "x-codegen-request-body-name": "companyPaymentsPost", "x-hideTryIt": true } }, "/visab2bconnect/v1/sendMessage": { "post": { "tags": [ "Payments API" ], "summary": "Send Message", "description": "This endpoint is used to send a message notification to the Originating bank or Beneficiary Bank.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "maxLength": 350, "type": "string", "description": "Freeform text, mandatory, up to 350 alphanumeric characters" }, "category": { "type": "string", "description": "Pre-defined list, mandatory", "enum": [ "Unable To Apply Funds", "Claim Non-Receipt of Funds", "Additional Payment Information", "Resolution Of Investigation", "Notification of Case Assignment", "Reject Investigation", "Cancel Case Assignment", "Request for Duplicate", "Duplicate", "Proprietary Format Investigation", "Debit Authorization Response", "Debit Authorization Request", "Case Status Report Request", "Case Status Report", "Customer Payment Cancellation Request", "FI to FI Payment Cancellation Request", "Request to Modify Payment" ] }, "paymentId": { "type": "string", "description": "Payment ID, mandatory if transactionId not present" }, "transactionId": { "type": "string", "description": "Transaction ID, mandatory if paymentId not present" } } }, "examples": { "Send Message": { "summary": "Send Message", "value": { "paymentId": "1000000000292131", "message": "Testing", "category": "Request for Duplicate" } } } } }, "required": true }, "responses": { "200": { "description": "Message sent successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "category": { "type": "string" }, "paymentId": { "type": "string" }, "responseList": { "type": "array", "items": { "type": "object", "properties": { "reasonCode": { "type": "string" }, "reasonDesc": { "type": "string" } } } }, "transactionId": { "type": "string" } } }, "examples": { "Send Message": { "summary": "Send Message", "value": { "paymentId": "1000000000292131", "responseList": [ { "reasonCode": "Z210", "reasonDesc": "Message delivery successful" } ], "message": "Testing", "category": "Request for Duplicate", "status": "Success" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" }, "description": { "type": "object" } } } } } } } } } }, "x-codegen-request-body-name": "body", "x-operationVersions": [ { "label": "v1", "operationPointer": "#/paths/~1visab2bconnect~1v1~1sendMessage/post", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/payments/bankId/{bankId}/searchType/{searchType}/keyword/{keyword}": { "get": { "tags": [ "Payments API" ], "summary": "Search for a previous payment.", "description": "This API allows Participant Bank to search for payment it initiated and/or received on Visa B2B Connect Network", "operationId": "Search Payments", "parameters": [ { "name": "bankId", "in": "path", "description": "Visa -issued Business ID (BID) of participant bank", "required": true, "explode": false, "schema": { "maxLength": 11, "minLength": 8, "type": "string", "format": "8-11 characters" } }, { "name": "searchType", "in": "path", "description": "Use I for Incoming to Visa. Use O for Outgoing from Visa.", "required": true, "explode": false, "schema": { "type": "string" } }, { "name": "keyword", "in": "path", "description": "Can search with anything related to the bank or payment", "required": true, "explode": false, "schema": { "minLength": 3, "type": "string", "format": "min 3 characters" } }, { "name": "fromDate", "in": "query", "description": "Date range for payment creation date", "required": false, "explode": true, "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "description": "Date ragne for payment creation date", "required": false, "explode": true, "schema": { "type": "string", "format": "date" } }, { "name": "cursor", "in": "query", "description": "The link to the next set of payments", "required": false, "explode": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "reccount", "in": "query", "description": "The number of records that will be displayed", "required": false, "explode": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successful request *
(response can include some additional clarifications to describe the result, instead of error message.
For e.g. \"errorMessages\":[\"No payment information found with the search keyword\"])", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/companySearchPaymentsResponse_14" } }, "examples": { "Search Payment by Bank ID": { "summary": "Search Payment by Bank ID", "value": { "pagingData": [ { "originatingBankBID": "67778901", "chargeBearer": "CRED", "fxRate": "0.67781", "intermediaryAgentName": "Intermediary Test Bank", "creditorAgentBranchName": "Austin branch", "creditorAgentTaxID": "A3BCD1234ABCD1234A1B2C3D41234ABC123", "expectedSettlementDate": "2019-09-25", "type": "In Network", "senderEnterpriseId": "V-USA-EUR-10080373-100000001-001", "originatingBankBIC": "ABDGAU36", "debtorAgentCountryCode": "null", "paymentId": "000000001", "recipientCorpName": "FITCH SOLUTION", "creditorContactName": "test name", "creditorLEI": "529900T8BM49AURSDO55", "recipientBankName": "BARCLAYS BANK", "customerAccountNumber": "7524515555", "creditorAgentInstruction": "test payment", "debtorAgentClearingMemberIDType": "null", "serviceLevel": "STANDARD", "intermediaryAgentCountry": "DE", "recieverEnterpriseId": "V-USA-EUR-20990373-100000001-004", "creditorAgentCountryCode": "LY", "instructingReimbursementAgent": "VISAUS35", "creditorAgentIBAN": "test data", "uetr": "123456789", "paymentMethod": "Batch Payment", "paymentPurpose": "test", "creditorTaxID": "749273", "loanReferenceNumber": "LRN1234567890", "transactionID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYU2", "actualSettlementDate": "2019-09-25", "unstructuredRemittance": "test", "recipientBankBID": "89000100", "total": "500.00", "originatingCorporateName": "KEYSTONE", "currency": "EUR", "debtorAgentClearingMemberID": "null", "paymentStatus": "Pending Settlement", "recipientBankBIC": "BARCGB22", "creditorAgentBranchID": "1312312", "paymentCreatedDateTime": "2018-09-23T17:48:58", "creditorAgentClearingMemberIDType": "ABA", "paymentPurposeCode2": "A2BCD1234ABCD1234A1B2C3D41234ABC123", "creditorContactPhoneNumber": "+1-8099087769", "paymentPurposeCode": "A1BCD1234ABCD1234A1B2C3D41234ABC123", "intermediaryAgentBic": "TESTDEBB", "endToEndID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYUH", "invoiceList": [ { "notes": "For Garments", "invoiceNumber": "54trtrt", "paymentCurrencyIsoCode": 840, "paymentCurrency": "USD", "poNumber": "66tytutur", "paymentAmount": 500, "partialPayment": false } ], "intermediaryAgentAddress": "10 Birkelweg Frankfurt am Main Germany", "fxTradeReferenceNumber": "bc77a8c6ded5400d820ab1c722efc036", "statusText": "Pending Settlement", "creditorAgentClearingMemberID": "SUF9823374", "lastUpdatedDateTime": "2018-09-23T17:49:20", "valueAddedTaxIndicator": "INC788", "originatingBankName": "PNC BANK NATIONAL" } ], "startIndex": "000000001", "totalRecords": 1, "nexturl": "/visab2bconnect/v1/payments/bankId/89000100/searchType/I/keyword/89000100?cursor=00000000124&reccount=5", "endIndex": null, "remainingRecords": "N/A", "pageSize": 1, "nextIndex": "N/A" } }, "Search Payment by Bank BIC": { "summary": "Search Payment by Bank BIC", "value": { "pagingData": [ { "originatingBankBID": "67778901", "chargeBearer": "CRED", "fxRate": "0.67781", "intermediaryAgentName": "Intermediary Test Bank", "creditorAgentBranchName": "Austin branch", "creditorAgentTaxID": "A3BCD1234ABCD1234A1B2C3D41234ABC123", "expectedSettlementDate": "2019-09-25", "type": "In Network", "senderEnterpriseId": "V-USA-EUR-10080373-100000001-001", "originatingBankBIC": "ABDGAU36", "debtorAgentCountryCode": "null", "paymentId": "000000001", "recipientCorpName": "FITCH SOLUTION", "creditorContactName": "test name", "creditorLEI": "529900T8BM49AURSDO55", "recipientBankName": "BARCLAYS BANK", "customerAccountNumber": "7524515555", "creditorAgentInstruction": "test payment", "debtorAgentClearingMemberIDType": "null", "serviceLevel": "STANDARD", "intermediaryAgentCountry": "DE", "recieverEnterpriseId": "V-USA-EUR-20990373-100000001-004", "creditorAgentCountryCode": "LY", "instructingReimbursementAgent": "VISAUS35", "creditorAgentIBAN": "test data", "uetr": "123456789", "paymentMethod": "Batch Payment", "paymentPurpose": "test", "creditorTaxID": "749273", "loanReferenceNumber": "LRN1234567890", "transactionID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYU2", "actualSettlementDate": "2019-09-25", "unstructuredRemittance": "test", "recipientBankBID": "89000100", "total": "500.00", "originatingCorporateName": "KEYSTONE", "currency": "EUR", "debtorAgentClearingMemberID": "null", "paymentStatus": "Pending Settlement", "recipientBankBIC": "BARCGB22", "creditorAgentBranchID": "1312312", "paymentCreatedDateTime": "2018-09-23T17:48:58", "creditorAgentClearingMemberIDType": "ABA", "paymentPurposeCode2": "A2BCD1234ABCD1234A1B2C3D41234ABC123", "creditorContactPhoneNumber": "+1-8099087769", "paymentPurposeCode": "A1BCD1234ABCD1234A1B2C3D41234ABC123", "intermediaryAgentBic": "TESTDEBB", "endToEndID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYUH", "invoiceList": [ { "notes": "For Garments", "invoiceNumber": "54trtrt", "paymentCurrencyIsoCode": 840, "paymentCurrency": "USD", "poNumber": "66tytutur", "paymentAmount": 500, "partialPayment": false } ], "intermediaryAgentAddress": "10 Birkelweg Frankfurt am Main Germany", "fxTradeReferenceNumber": "bc77a8c6ded5400d820ab1c722efc036", "statusText": "Pending Settlement", "creditorAgentClearingMemberID": "SUF9823374", "lastUpdatedDateTime": "2018-09-23T17:49:20", "valueAddedTaxIndicator": "INC788", "originatingBankName": "PNC BANK NATIONAL" } ], "startIndex": "000000001", "totalRecords": 2, "nexturl": "/visab2bconnect/v1/payments/bankId/67778901/searchType/O/keyword/ABDGAU36?cursor=000000002&reccount=2", "endIndex": "000000001", "remainingRecords": "1", "pageSize": 1, "nextIndex": "000000002" } }, "Search Payment by Clearing Member ID": { "summary": "Search Payment by Clearing Member ID", "value": { "pagingData": [ { "originatingBankBID": "12345678", "chargeBearer": "DEBT", "fxRate": "0.67781", "intermediaryAgentName": "Intermediary Test Bank", "creditorAgentBranchName": "Austin branch", "creditorAgentTaxID": null, "expectedSettlementDate": "2019-09-25", "type": "In Network", "senderEnterpriseId": "V-USA-INR-10080373-100000001-001", "originatingBankBIC": "null", "debtorAgentCountryCode": "US", "paymentId": "00000000124", "recipientCorpName": "FITCH SOLUTION", "creditorContactName": null, "recipientBankName": "YES BANK", "customerAccountNumber": "7524515555", "creditorAgentInstruction": "test payment", "debtorAgentClearingMemberIDType": "USABA", "serviceLevel": "STANDARD", "intermediaryAgentCountry": "DE", "recieverEnterpriseId": "V-USA-EUR-20990373-100000001-004", "creditorAgentCountryCode": "LY", "instructingReimbursementAgent": "VISAUS33", "creditorAgentIBAN": null, "paymentMethod": "Batch Payment", "paymentPurpose": "test", "creditorTaxID": "749273", "transactionID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY65", "actualSettlementDate": "2019-09-25", "unstructuredRemittance": "test", "recipientBankBID": "89000100", "total": "500.00", "originatingCorporateName": "KEYSTONE", "currency": "INR", "debtorAgentClearingMemberID": "062001186", "paymentStatus": "Pending Settlement", "recipientBankBIC": "BARCGB22", "creditorAgentBranchID": "8237492", "paymentCreatedDateTime": "2018-09-26T12:32:09", "creditorAgentClearingMemberIDType": "ABA", "paymentPurposeCode2": null, "creditorContactPhoneNumber": "+1-8099087766", "paymentPurposeCode": null, "intermediaryAgentBic": "TESTDEBB", "endToEndID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY64", "invoiceList": [ { "notes": "For Garments", "invoiceNumber": "54trtrt", "paymentCurrencyIsoCode": 840, "paymentCurrency": "USD", "poNumber": "66tytutur", "paymentAmount": 500, "partialPayment": false } ], "intermediaryAgentAddress": "10 Birkelweg Frankfurt am Main Germany", "fxTradeReferenceNumber": "c11fd800db9f4e12a1509ee50ba8186b", "statusText": "Pending Settlement", "creditorAgentClearingMemberID": "SUF9823374", "lastUpdatedDateTime": "2018-09-26T12:32:13", "valueAddedTaxIndicator": "EX788", "originatingBankName": "PNC BANK NATIONAL" }, { "originatingBankBID": "12345678", "chargeBearer": "DEBT", "fxRate": "0.67781", "intermediaryAgentName": "Intermediary Test Bank", "creditorAgentBranchName": "Austin branch", "creditorAgentTaxID": null, "expectedSettlementDate": "2019-09-25", "type": "In Network", "senderEnterpriseId": "V-USA-INR-10080373-100000001-001", "originatingBankBIC": "null", "debtorAgentCountryCode": "US", "paymentId": "00000000123", "recipientCorpName": "FITCH SOLUTION", "creditorContactName": null, "creditorLEI": "529900T8BM49AURSDO55", "recipientBankName": "YES BANK", "customerAccountNumber": "7524515555", "creditorAgentInstruction": "test payment", "debtorAgentClearingMemberIDType": "USABA", "serviceLevel": "STANDARD", "intermediaryAgentCountry": "DE", "recieverEnterpriseId": "V-USA-EUR-20990373-100000001-004", "creditorAgentCountryCode": "LY", "instructingReimbursementAgent": "VISAUS33", "creditorAgentIBAN": null, "uetr": "123456789", "paymentMethod": "Batch Payment", "paymentPurpose": "test", "creditorTaxID": "749273", "loanReferenceNumber": "LRN1234567890", "transactionID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY65", "actualSettlementDate": "2019-09-25", "unstructuredRemittance": "test", "recipientBankBID": "89000100", "total": "500.00", "originatingCorporateName": "KEYSTONE", "currency": "INR", "debtorAgentClearingMemberID": "062001186", "paymentStatus": "Pending Settlement", "recipientBankBIC": "BARCGB22", "creditorAgentBranchID": "8237492", "paymentCreatedDateTime": "2018-09-26T12:32:09", "creditorAgentClearingMemberIDType": "ABA", "paymentPurposeCode2": null, "creditorContactPhoneNumber": "+1-8099087766", "paymentPurposeCode": null, "intermediaryAgentBic": "TESTDEBB", "endToEndID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY64", "invoiceList": [ { "notes": "For Garments", "invoiceNumber": "54trtrt", "paymentCurrencyIsoCode": 840, "paymentCurrency": "USD", "poNumber": "66tytutur", "paymentAmount": 500, "partialPayment": false } ], "intermediaryAgentAddress": "10 Birkelweg Frankfurt am Main Germany", "fxTradeReferenceNumber": "c11fd800db9f4e12a1509ee50ba8186b", "statusText": "Pending Settlement", "creditorAgentClearingMemberID": "SUF9823374", "lastUpdatedDateTime": "2018-09-26T12:32:13", "valueAddedTaxIndicator": "EX788", "originatingBankName": "PNC BANK NATIONAL" } ], "startIndex": "00000000124", "totalRecords": 5, "nexturl": "/visab2bconnect/v1/payments/bankId/12345678/searchType/O/keyword/062001186?cursor=00000000122&reccount=5", "endIndex": "00000000123", "remainingRecords": "3", "pageSize": 2, "nextIndex": "00000000122" } }, "Search Payment by Keyword": { "summary": "Search Payment by Keyword", "value": { "pagingData": [ { "originatingBankBID": "12345678", "chargeBearer": "DEBT", "fxRate": "0.67781", "intermediaryAgentName": "Intermediary Test Bank", "creditorAgentBranchName": "Austin branch", "creditorAgentTaxID": null, "expectedSettlementDate": "2019-09-25", "type": "In Network", "senderEnterpriseId": "V-USA-INR-10080373-100000001-001", "originatingBankBIC": "ABDGAU36", "debtorAgentCountryCode": "US", "paymentId": "00000000124", "recipientCorpName": "FITCH SOLUTION", "creditorContactName": null, "recipientBankName": "YES BANK", "customerAccountNumber": "7524515555", "creditorAgentInstruction": "test payment", "debtorAgentClearingMemberIDType": "USABA", "serviceLevel": "STANDARD", "intermediaryAgentCountry": "DE", "recieverEnterpriseId": "V-USA-EUR-20990373-100000001-004", "creditorAgentCountryCode": "LY", "instructingReimbursementAgent": "VISAUS33", "creditorAgentIBAN": null, "paymentMethod": "Batch Payment", "paymentPurpose": "test", "creditorTaxID": "749273", "transactionID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY65", "actualSettlementDate": "2019-09-25", "unstructuredRemittance": "test", "recipientBankBID": "89000100", "total": "500.00", "originatingCorporateName": "KEYSTONE", "currency": "INR", "debtorAgentClearingMemberID": "062001186", "paymentStatus": "Pending Settlement", "recipientBankBIC": "BARCGB22", "creditorAgentBranchID": "8237492", "paymentCreatedDateTime": "2018-09-26T12:32:09", "creditorAgentClearingMemberIDType": "ABA", "paymentPurposeCode2": null, "creditorContactPhoneNumber": "+1-8099087766", "paymentPurposeCode": null, "intermediaryAgentBic": "TESTDEBB", "endToEndID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY64", "invoiceList": [ { "notes": "For Garments", "invoiceNumber": "54trtrt", "paymentCurrencyIsoCode": 840, "paymentCurrency": "USD", "poNumber": "66tytutur", "paymentAmount": 500, "partialPayment": false } ], "intermediaryAgentAddress": "10 Birkelweg Frankfurt am Main Germany", "fxTradeReferenceNumber": "c11fd800db9f4e12a1509ee50ba8186b", "statusText": "Pending Settlement", "creditorAgentClearingMemberID": "SUF9823374", "lastUpdatedDateTime": "2018-09-26T12:32:13", "valueAddedTaxIndicator": "EX788", "originatingBankName": "PNC BANK NATIONAL" }, { "originatingBankBID": "12345678", "chargeBearer": "DEBT", "fxRate": "0.67781", "intermediaryAgentName": "Intermediary Test Bank", "creditorAgentBranchName": "Austin branch", "creditorAgentTaxID": null, "expectedSettlementDate": "2019-09-25", "type": "In Network", "senderEnterpriseId": "V-USA-INR-10080373-100000001-001", "originatingBankBIC": "ABDGAU36", "debtorAgentCountryCode": "US", "paymentId": "00000000123", "recipientCorpName": "FITCH SOLUTION", "creditorContactName": null, "creditorLEI": "529900T8BM49AURSDO55", "recipientBankName": "YES BANK", "customerAccountNumber": "7524515555", "creditorAgentInstruction": "test payment", "debtorAgentClearingMemberIDType": "USABA", "serviceLevel": "STANDARD", "intermediaryAgentCountry": "DE", "recieverEnterpriseId": "V-USA-EUR-20990373-100000001-004", "creditorAgentCountryCode": "LY", "instructingReimbursementAgent": "VISAUS33", "creditorAgentIBAN": null, "uetr": "123456789", "paymentMethod": "Batch Payment", "paymentPurpose": "test", "creditorTaxID": "749273", "loanReferenceNumber": "LRN1234567890", "transactionID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY65", "actualSettlementDate": "2019-09-25", "unstructuredRemittance": "test", "recipientBankBID": "89000100", "total": "500.00", "originatingCorporateName": "KEYSTONE", "currency": "INR", "debtorAgentClearingMemberID": "062001186", "paymentStatus": "Pending Settlement", "recipientBankBIC": "BARCGB22", "creditorAgentBranchID": "8237492", "paymentCreatedDateTime": "2018-09-26T12:32:09", "creditorAgentClearingMemberIDType": "ABA", "paymentPurposeCode2": null, "creditorContactPhoneNumber": "+1-8099087766", "paymentPurposeCode": null, "intermediaryAgentBic": "TESTDEBB", "endToEndID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY64", "invoiceList": [ { "notes": "For Garments", "invoiceNumber": "54trtrt", "paymentCurrencyIsoCode": 840, "paymentCurrency": "USD", "poNumber": "66tytutur", "paymentAmount": 500, "partialPayment": false } ], "intermediaryAgentAddress": "10 Birkelweg Frankfurt am Main Germany", "fxTradeReferenceNumber": "c11fd800db9f4e12a1509ee50ba8186b", "statusText": "Pending Settlement", "creditorAgentClearingMemberID": "SUF9823374", "lastUpdatedDateTime": "2018-09-26T12:32:13", "valueAddedTaxIndicator": "EX788", "originatingBankName": "PNC BANK NATIONAL" } ], "startIndex": "00000000124", "totalRecords": 5, "nexturl": "/visab2bconnect/v1/payments/bankId/12345678/searchType/O/keyword/EUR?cursor=00000000122&reccount=5", "endIndex": "00000000123", "remainingRecords": "3", "pageSize": 2, "nextIndex": "00000000122" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseMessage_14" } } } } }, "x-name": "Search for a previous payment.", "x-notes": "Retrieve a previous payment by specifying the BID (Visa issued Business ID) of the bank and the type of payment which is either Incoming to Visa (searchType- I) or Outgoing from Visa (searchType- O).", "x-operationVersions": [ { "label": "v1", "operationPointer": "#/paths/~1visab2bconnect~1v1~1payments~1bankId~1{bankId}~1searchType~1{searchType}~1keyword~1{keyword}/get", "default": false } ], "x-sampleResponse": { "nexturl": "/visab2bconnect/v1/payments/bankId/12222225/searchType/O/keyword/REGRCA1QXXX?fromDate=2019-12-06&toDate=2019-12-07&cursor=1000000000078950&reccount=29", "endIndex": "100000089", "pageSize": 2, "nextIndex": "100002558", "pagingData": [ { "type": "In Network", "uetr": "123456789", "total": "50000.00", "fxRate": "0.90", "currency": "EUR", "paymentId": "1000000000463730", "endToEndID": "GSBNRH6B89GHAZ0RUGNIN3KRXAPIZZCXYUH", "statusText": "Payment On Hold", "creditorLEI": "529900T8BM49AURSDO55", "invoiceList": [ { "notes": "Payment as Agreed", "poNumber": "321", "invoiceNumber": "123", "paymentAmount": 50000, "partialPayment": false, "paymentCurrency": "EUR", "paymentCurrencyIsoCode": 978 } ], "serviceLevel": "STANDARD", "creditorTaxID": "v2ae197e-7d0e-487f-8829-a1990ccde35f", "paymentMethod": "API", "paymentStatus": "Pending Settlement", "transactionID": "BD9ISCA5KT0XXIQSRLQXF7S5L5JBG4KQY6P", "paymentPurpose": "test", "recipientBankBIC": "LMNOZZEFXXX", "recipientBankBID": "12341234", "recipientBankName": "Receiver Bank", "recipientCorpName": "Receiver Company", "creditorAgentTaxID": "A1BCD1234ABCD1234A1B2C3D41234ABC123", "originatingBankBIC": "ABCDUSEFXXX", "originatingBankBID": "43214321", "paymentDateAndTime": "2020-04-31T09:10:37", "paymentPurposeCode": "A1BCD1234ABCD1234A1B2C3D41234ABC123", "senderEnterpriseId": "V-USA-EUR-20373-2342-004", "creditorContactName": "Contact Name", "lastUpdatedDateTime": "2020-04-31T09:10:37", "loanReferenceNumber": "LRN1234567890", "originatingBankName": "Originating Bank", "paymentPurposeCode2": "A1BCD1234ABCD1234A1B2C3D41234ABC123", "actualSettlementDate": "2020-03-31T09:10:37", "intermediaryAgentBic": "TESTDEBB", "recieverEnterpriseId": "V-USA-EUR-9835334-2432-001", "creditorAccountNumber": "08080088", "creditorAgentBranchID": "A1BCD1234ABCD1234A1B2C3D41234ABC123", "customerAccountNumber": "07070077", "intermediaryAgentName": "Intermediary Test Bank", "expectedSettlementDate": "2020-04-03T09:10:37", "fxTradeReferenceNumber": "BD9ISCA5KT0XXIQSRLQXF7S5L9JBG4KQY6P", "unstructuredRemittance": "test", "valueAddedTaxIndicator": "INC", "creditorAgentBranchName": "Creditor Test Branch Name", "creditorAgentCountryCode": "LY", "creditorAgentInstruction": "test", "intermediaryAgentAddress": "10 Birkelweg Frankfurt am Main Germany", "intermediaryAgentCountry": "DE", "originatingCorporateName": "Payer Company", "creditorContactPhoneNumber": "+012-1231231234", "creditorAgentClearingMemberID": "062200961", "instructingReimbursementAgent": "AABBGBCCXXX", "creditorAgentClearingMemberIDType": "USABA" } ], "startIndex": "100000039", "totalRecords": 1, "remainingRecords": "0" }, "x-hideTryIt": true } }, "/visab2bconnect/v1/payments/paymentStatusUpdate": { "post": { "tags": [ "Payments API" ], "summary": "Update Payment Status", "description": "Update Payment Status", "operationId": "Update Payment Status", "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "required": [ "action" ], "type": "object", "properties": { "action": { "type": "string", "description": "One of the possible values {RECALL, REJECT, BENECONFIRM, RECALLACCEPT or RECALLREJECT}" }, "comments": { "type": "string", "description": "Comments, applicable for all Actions. Max 350 characters" }, "paymentId": { "type": "string", "description": "Mandatory if endToEndId or transactionId is not provided" }, "endToEndId": { "type": "string", "description": "Mandatory if paymentId or transactionId is not provided" }, "exchangeRate": { "type": "string", "description": "To be used when beneficiary/creditor account is credited in currency other than Settlement Currency" }, "transactionId": { "type": "string", "description": "Mandatory if endToEndId or paymentId is not provided" }, "actionReasonCode": { "type": "string", "description": "Reason for RECALL and REJECT Actions, required if action is RECALL or REJECT" }, "instructedAmount": { "type": "string", "description": "Instructed Amount of payment for Action=BENECONFIRM" }, "instructedCurrency": { "type": "string", "description": "Instructed Currency of payment for Action=BENECONFIRM" }, "beneficiaryCreditDateTime": { "type": "string", "description": "Date and Time of funds availability to Beneficiary/Creditor for Action=BENECONFIRM" } } }, "examples": { "Default": { "summary": "Default", "value": { "instructedCurrency": null, "beneficiaryCreditDateTime": null, "comments": null, "actionReasonCode": "AGNT", "exchangeRate": null, "paymentId": "1000000000000158", "action": "RECALL", "instructedAmount": null, "endToEndId": null, "transactionId": null } } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "paymentStatusUpdateResponse": { "type": "object", "properties": { "action": { "type": "string", "description": "replay from request" }, "comments": { "type": "string", "description": "replay from request" }, "paymentId": { "type": "string", "description": "replay from request" }, "endToEndId": { "type": "string", "description": "replay from request" }, "exchangeRate": { "type": "string" }, "responseList": { "type": "array", "items": { "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code" }, "reasonDesc": { "type": "string", "description": "Reason Description" } } } }, "transactionId": { "type": "string", "description": "replay from request" }, "actionDateTime": { "type": "string" }, "actionReasonCode": { "type": "string", "description": "replay from request" }, "actionReasonDesc": { "type": "string", "description": "replay from request. Description for actionReasonDesc" }, "instructedAmount": { "type": "string", "description": "replay from request" }, "instructedCurrency": { "type": "string", "description": "replay from request" }, "beneficiaryCreditDateTime": { "type": "string", "description": "replay from request" } }, "description": "Successful request" } } }, "examples": { "Default": { "summary": "Default", "value": { "comments": null, "actionReasonCode": "AGNT", "actionDateTime": "2019-02-25T10:38:09", "endToEndId": null, "transactionId": null, "actionReasonDesc": "Agent in the payment workflow is incorrect", "instructedCurrency": null, "beneficiaryCreditDateTime": null, "exchangeRate": null, "paymentId": "1000000000000158", "action": "RECALL", "responseList": [ { "reasonCode": "Z201", "reasonDesc": "Payment Status Update successful" } ], "instructedAmount": null } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "description": "replay from request" }, "comments": { "type": "string", "description": "replay from request" }, "paymentId": { "type": "string", "description": "replay from request" }, "endToEndId": { "type": "string", "description": "replay from request" }, "exchangeRate": { "type": "string" }, "responseList": { "type": "array", "items": { "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code" }, "reasonDesc": { "type": "string", "description": "Reason Description" } } } }, "transactionId": { "type": "string", "description": "replay from request" }, "actionDateTime": { "type": "string" }, "actionReasonCode": { "type": "string", "description": "replay from request" }, "actionReasonDesc": { "type": "string", "description": "replay from request. Description for actionReasonDesc" }, "instructedAmount": { "type": "string", "description": "replay from request" }, "instructedCurrency": { "type": "string", "description": "replay from request" }, "beneficiaryCreditDateTime": { "type": "string", "description": "replay from request" } } } } } }, "401": { "description": "Unauthorized Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "description": "Displays error messages, if any", "items": { "type": "object", "properties": { "type": { "type": "object" }, "description": { "type": "object" } } } } } } } } } }, "x-codegen-request-body-name": "paymentStatusUpdatePost", "x-operationVersions": [ { "label": "v1", "operationPointer": "#/paths/~1visab2bconnect~1v1~1payments~1paymentStatusUpdate/post", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/fees/fxRatesCalculator": { "get": { "tags": [ "Payments API" ], "summary": "Get the Effective Conversion Rate", "description": "This API provides foreign exchange rate (Spot Rates) for currencies supported by B2B Connect Service", "operationId": "Get the Effective Conversion Rate", "parameters": [ { "name": "sourceCurrencyAlphaCode", "in": "query", "description": "Currency of the Originator of the payment (Valid ISO 4217 3-alpha currency code)", "required": true, "style": "form", "explode": true, "schema": { "maxLength": 3, "minLength": 3, "type": "string", "format": "3 characters" } }, { "name": "targetCurrencyAlphaCode", "in": "query", "description": "Currency of the payment recipient (Valid ISO 4217 3-alpha currency code)", "required": true, "style": "form", "explode": true, "schema": { "maxLength": 3, "minLength": 3, "type": "string", "format": "3 characters" } }, { "name": "markup", "in": "query", "description": "Optional markup to be applied to exchange rate in response. Must be a positive decimal value with a maximum of 4 integers and 5 decimal places. Min is 0.00001 (basis points).", "required": false, "style": "form", "explode": true, "schema": { "multipleOf": 0.00001, "maxLength": 10, "type": "number", "format": "number(9,5)" } }, { "name": "requestId", "in": "query", "description": "Unique identifier for tracking rate request", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 35, "type": "string", "format": "up to 35 characters" } } ], "responses": { "200": { "description": "Successful request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fxRatesCalculatorResponse" }, "examples": { "Default": { "summary": "Default", "value": { "effectiveConversionRate": 0.66206931, "targetCurrency": "GBP", "requestId": "A1234BCD1234ABCD4321ABCD", "sourceCurrency": "USD", "rateExpiry": "2020-04-31T09:10:37", "rateId": "123412341234", "effectiveConversionRateWithMarkup": 0.66206931 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseMessage" } } } }, "500": { "description": "Server Error or Exception", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseMessage" } } } } }, "x-operationVersions": [ { "label": "v1", "operationPointer": "#/paths/~1visab2bconnect~1v1~1fees~1fxRatesCalculator/get", "default": false }, { "label": "v2 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v2~1fees~1fxRatesCalculator/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/payments/validateEligibility": { "post": { "tags": [ "Payments API" ], "summary": "Validate Payment Eligibility", "description": "Validate Payment Eligibility.", "operationId": "Validate Payment Eligibility", "parameters": [ { "name": "relationship-id", "in": "header", "description": "subsidiary Clearing MemberID OR subsidiary Bank Bic", "required": false, "explode": false, "schema": { "type": "string", "format": "BIC" } } ], "requestBody": { "description": "Request body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentEligibilityRequest_15" }, "examples": { "Validate Eligibility by BIC": { "summary": "Validate Eligibility by BIC", "value": { "debtorBankBic": "VISAUS33", "settlementCurrency": "USD", "debtorEnterpriseId": "V-USA-USD-25062019-100670398-001", "settlementAmount": "1.00", "creditorEnterpriseId": "V-USA-USD-80907060-100670403-001", "creditorBankBic": "EPMTUSLLXXX" } }, "Validate Eligibility by Clearing Member ID": { "summary": "Validate Eligibility by Clearing Member ID", "value": { "settlementCurrency": "USD", "debtorEnterpriseId": "V-USA-USD-25062019-100670398-001", "settlementAmount": "1.00", "debtorAgentClearingMemberIDType": "USABA", "debtorAgentClearingMemberID": "062001186", "creditorEnterpriseId": "V-USA-USD-80907060-100670403-001", "creditorBankBic": "EPMTUSLLXXX" } } } } }, "required": true }, "responses": { "200": { "description": "Successful request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentEligibilityResponse_15" }, "examples": { "Validate Eligibility by BIC": { "summary": "Validate Eligibility by BIC", "value": { "debtorEnterpriseId": "V-USA-USD-25062019-100670398-001", "responseList": [ { "reasonCode": "SU10", "reasonDesc": " Payment eligibility validation success." } ], "type": "In Network", "creditorEnterpriseId": "V-USA-USD-80907060-100670403-001" } }, "Validate Eligibility by Clearing Member ID": { "summary": "Validate Eligibility by Clearing Member ID", "value": { "debtorEnterpriseId": "V-USA-USD-25062019-100670398-001", "responseList": [ { "reasonCode": "SU10", "reasonDesc": " Payment eligibility validation success." } ], "type": "In Network", "creditorEnterpriseId": "V-USA-USD-80907060-100670403-001" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentEligibilityResponse_15" }, "example": { "responseList": [ { "reasonCode": "BE20", "reasonDesc": "Debtor corporate not enabled for transaction" } ], "debtorEnterpriseId": "V-USA-EUR-10080373-100000001-001", "creditorEnterpriseId": "V-USA-USA-80373100-100000891-185" } } } }, "401": { "description": "Unauthorized Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseMessage_15" } } } } }, "x-samplePayload": { "debtorIBAN": "ZZ123412341234123412341234", "creditorIBAN": "ZZ43214321432143214321", "debtorBankBic": "ABCDUSEFXXX", "debtorCountry": "FRA", "creditorBankBic": "LMNOZZEFXXX", "creditorCountry": "USA", "settlementAmount": 500000, "debtorEnterpriseId": "V-USA-EUR-10080373-100000001-001", "settlementCurrency": "EUR", "debtorAccountNumber": "07070077", "creditorEnterpriseId": "V-USA-USA-80373100-100000891-185", "creditorAccountNumber": "08080088", "creditorAgentCountryCode": "LY", "creditorAgentClearingMemberID": "062200961", "creditorAgentClearingMemberIDType": "USABA" }, "x-name": "Validate Payment Eligibility", "x-notes": "Pre-validate payment details", "x-operationVersions": [ { "label": "v1", "operationPointer": "#/paths/~1visab2bconnect~1v1~1payments~1validateEligibility/post", "default": false } ], "x-codegen-request-body-name": "paymentEligibilityPost", "x-hideTryIt": true } }, "/visab2bconnect/v2/fees/fxRatesCalculator": { "get": { "tags": [ "Payments API" ], "summary": "Get the Effective Conversion Rate", "description": "This API allows request for an exchange rate for a currency pair. This exchange rate is valid for the duration specified by Rate Expiry Date/Time.", "operationId": "Get the Effective Conversion Rate", "parameters": [ { "name": "settlementCurrency", "in": "query", "description": "Currency of the Originator of the payment (Valid ISO 4217 3-alpha currency code)", "required": true, "style": "form", "explode": true, "schema": { "maxLength": 3, "minLength": 3, "type": "string", "format": "3 characters" } }, { "name": "instructedCurrency", "in": "query", "description": "Currency of the payment recipient (Valid ISO 4217 3-alpha currency code)", "required": true, "style": "form", "explode": true, "schema": { "maxLength": 3, "minLength": 3, "type": "string", "format": "3 characters" } }, { "name": "markup", "in": "query", "description": "Optional markup to be applied to exchange rate in response. Must be a positive decimal value with a maximum of 4 integers and 5 decimal places. Min is 0.00001 (basis points).", "required": false, "style": "form", "explode": true, "schema": { "multipleOf": 0.00001, "maxLength": 10, "type": "number", "format": "number(9,5)" } }, { "name": "requestId", "in": "query", "description": "Unique identifier for tracking rate request", "required": false, "style": "form", "explode": true, "schema": { "maxLength": 35, "type": "string", "format": "up to 35 characters" } } ], "responses": { "200": { "description": "Successful request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fxRatesCalculatorResponse-1" }, "examples": { "FX Rate without Markup": { "summary": "FX Rate without Markup", "value": { "effectiveConversionRate": 0.61031705, "targetCurrency": "GBP", "requestId": "123", "sourceCurrency": "AUD", "rateExpiry": "2024-06-04T15:47:11.714Z", "rateId": "52f50413-efe9-4e90-9c2b-ace3f57a12db" } }, "FX Rate with Markup": { "summary": "FX Rate with Markup", "value": { "effectiveConversionRate": 0.61031705, "targetCurrency": "GBP", "requestId": "A1234BCD1234ABCD4321ABCD", "sourceCurrency": "AUD", "rateExpiry": "2024-06-04T21:29:05.887Z", "rateId": "3eba6e35-2b40-4601-b9b4-f2dedf62bdf3", "effectiveConversionRateWithMarkup": 1.11031705 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseMessage" } } } }, "500": { "description": "Server Error or Exception", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/responseMessage" } } } } }, "x-hideTryIt": true } }, "/visab2bconnect/v1/global/notificationLookup": { "get": { "tags": [ "Reference Data API" ], "summary": "Notification Lookup", "description": "Lookup notification static value fields.", "operationId": "Notification Lookup", "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "notificationLookupResponse": { "required": [ "attachmentFormats", "deliveryMethods", "frequency" ], "type": "object", "properties": { "frequency": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Frequency of notficiaton. Options could be: Upon Payment or Every Day" }, "value": { "type": "string", "description": "Corresponding value of the frequency" } } } }, "deliveryMethods": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Delivery method" }, "value": { "type": "string", "description": "Corresponding value of the delivery method" } } } }, "attachmentFormats": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Format of the attachment. Could be CSV, PDF, or XLS." }, "value": { "type": "string", "description": "Corresponding value of the attachment" } } } } }, "description": "Successful Request" } } }, "examples": { "Default": { "summary": "Default", "value": { "attachmentFormats": [ { "text": "CSV", "value": 11 }, { "text": "PDF", "value": 12 }, { "text": "XLS", "value": 13 } ], "deliveryMethods": [ { "text": "Email", "value": 1 } ], "frequency": [ { "text": "Upon Payment", "value": 21 }, { "text": "Every Day", "value": 22 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1global~1notificationLookup/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/global/supportedCurrencies": { "get": { "tags": [ "Reference Data API" ], "summary": "Get List of all Supported Currencies", "description": "Get the list of all Supported Currencies.", "operationId": "Get List of all Supported Currencies", "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "supportedCurrenciesResponse": { "required": [ "currencyAlphaCode", "currencyDescription", "currencyName", "decimalPositions" ], "type": "object", "properties": { "currencyName": { "type": "string", "description": "Name of the currency" }, "currencyISOCode": { "type": "integer", "description": "Currency of the country. Valid supported ISO 4217 3-numeric currency code", "format": "int32" }, "decimalPositions": { "type": "integer", "description": "Applicable decimal pisition with respect to the currency", "format": "int32" }, "currencyAlphaCode": { "type": "string", "description": "Currency of the country. Valid supported ISO 4217 3-charater currency code", "format": "3 characters" }, "currencyDescription": { "type": "string", "description": "Name of the currency" } }, "description": "Successful Request" } } }, "examples": { "Default": { "summary": "Default", "value": [ { "currencyAlphaCode": "JPY", "currencyDescription": "JAPANESE YEN", "currencyName": "JAPANESE YEN", "currencyISOCode": 392, "decimalPositions": 0 }, { "currencyAlphaCode": "SAR", "currencyDescription": "SAUDI RIYAL", "currencyName": "SAUDI RIYAL", "currencyISOCode": 682, "decimalPositions": 2 }, { "currencyAlphaCode": "SGD", "currencyDescription": "SINGAPORE DOLLAR", "currencyName": "SINGAPORE DOLLAR", "currencyISOCode": 702, "decimalPositions": 2 }, { "currencyAlphaCode": "THB", "currencyDescription": "THAI BAHT", "currencyName": "THAI BAHT", "currencyISOCode": 764, "decimalPositions": 2 }, { "currencyAlphaCode": "GBP", "currencyDescription": "POUND STERLING", "currencyName": "POUND STERLING", "currencyISOCode": 826, "decimalPositions": 2 }, { "currencyAlphaCode": "USD", "currencyDescription": "UNITED STATES DOLLAR", "currencyName": "UNITED STATES DOLLAR", "currencyISOCode": 840, "decimalPositions": 2 }, { "currencyAlphaCode": "EUR", "currencyDescription": "EURO", "currencyName": "EURO", "currencyISOCode": 978, "decimalPositions": 2 } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1global~1supportedCurrencies/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/global/defaultBlockedCorridors": { "get": { "tags": [ "Reference Data API" ], "summary": "Get Visa Defined Blocked Corridors", "description": "Get Visa Defined Blocked Countries.", "operationId": "Get Visa Defined Blocked Corridors", "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "defaultBlockedCorridorsResponse": { "required": [ "blockedDesc", "countryCode", "countryDisplayName", "isoCountryCode" ], "type": "object", "properties": { "blockedDesc": { "type": "string", "description": "Indicates if a country is blocked and what category of entity blocked it. Statuses are: visaBlocked, bankBlocked, companyBlocked and unblocked." }, "countryCode": { "type": "string", "description": "Valid supported ISO 3166 3-alpha country code", "format": "3 characters" }, "isoCountryCode": { "type": "integer", "description": "Valid supported ISO 3166 3 numeric country code" }, "countryDisplayName": { "type": "string", "description": "Name of the country" } }, "description": "Successful request" } } }, "examples": { "Default": { "summary": "Default", "value": [ { "blockedDesc": "visaBlocked", "countryCode": "CUB", "isoCountryCode": 192, "countryDisplayName": "CUBA" }, { "blockedDesc": "visaBlocked", "countryCode": "IRN", "isoCountryCode": 364, "countryDisplayName": "ISLAMIC REPUBLIC OF IRAN" }, { "blockedDesc": "visaBlocked", "countryCode": "PRK", "isoCountryCode": 408, "countryDisplayName": "NORTH KOREA" }, { "blockedDesc": "visaBlocked", "countryCode": "SDN", "isoCountryCode": 729, "countryDisplayName": "SUDAN" }, { "blockedDesc": "visaBlocked", "countryCode": "SYR", "isoCountryCode": 760, "countryDisplayName": "SYRIAN ARAB REPUBLIC" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1global~1defaultBlockedCorridors/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/global/industryCodes": { "get": { "tags": [ "Reference Data API" ], "summary": "Retrieve List of Industry Codes", "description": "Retrieve a list of all the industry codes.", "operationId": "Retrieve List of Industry Codes", "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "getIndustryCodesResponse": { "required": [ "sicCode", "sicDescription" ], "type": "object", "properties": { "sicCode": { "type": "string", "description": "1-6 digit code that categorizes the industries that companies belong to based on their business activities.", "format": "1-6 characters" }, "sicDescription": { "type": "string", "description": "Classifies divisions, major groups, industry areas, and Industries" } }, "description": "Successful Request" } } }, "examples": { "Default": { "summary": "Default", "value": [ { "sicCode": "11", "sicDescription": "Agriculture, Forestry, Fishing and Hunting" }, { "sicCode": "21", "sicDescription": "Mining, Quarrying, and Oil and Gas Extraction" }, { "sicCode": "22", "sicDescription": "Utilities" }, { "sicCode": "23", "sicDescription": "Construction" }, { "sicCode": "31", "sicDescription": "Manufacturing" }, { "sicCode": "32", "sicDescription": "Manufacturing" }, { "sicCode": "33", "sicDescription": "Manufacturing" }, { "sicCode": "42", "sicDescription": "Wholesale Trade" }, { "sicCode": "44", "sicDescription": "Retail Trade" }, { "sicCode": "45", "sicDescription": "Retail Trade" }, { "sicCode": "48", "sicDescription": "Transportation and Warehousing" }, { "sicCode": "49", "sicDescription": "Transportation and Warehousing" }, { "sicCode": "52", "sicDescription": "Finance and Insurance" }, { "sicCode": "53", "sicDescription": "Real Estate and Rental and Leasing" }, { "sicCode": "54", "sicDescription": "Professional, Scientific, and Technical Services" }, { "sicCode": "55", "sicDescription": "*Management of Companies and Enterprises*" }, { "sicCode": "56", "sicDescription": "Administrative and Support and Waste Management and Remediation Services" }, { "sicCode": "62", "sicDescription": "Health Care and Social Assistance" }, { "sicCode": "72", "sicDescription": "Arts, Entertainment, and Recreation" }, { "sicCode": "72", "sicDescription": "Accommodation and Food Services" }, { "sicCode": "81", "sicDescription": "Other Services (except Public Administration)" }, { "sicCode": "92", "sicDescription": "Public Administration" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1global~1industryCodes/get", "default": false } ], "x-hideTryIt": true } }, "/visab2bconnect/v1/suppliers/{searchString}": { "get": { "tags": [ "Reference Data API" ], "summary": "Search available suppliers", "description": "Search available suppliers", "operationId": "Search available suppliers", "parameters": [ { "name": "keyword", "in": "path", "description": "The search string to be used. Partial search is allowed.", "required": true, "style": "simple", "explode": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Links to the next set of results", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "reccount", "in": "query", "description": "The number of records that will be displayed", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ok", "content": { "application/json": { "schema": { "type": "object", "properties": { "searchSuppliersResponse": { "type": "object", "properties": { "nexturl": { "type": "string", "description": "Supports Paganization" }, "endIndex": { "type": "string", "description": "Supports Paganization" }, "pageSize": { "type": "integer", "description": "Supports Paganization", "format": "int64" }, "nextIndex": { "type": "string", "description": "Supports Paganization" }, "pagingData": { "required": [ "alphaCode", "bankId", "bankName", "companyId", "companyName", "countryIsoCode", "countryName", "defaultCurrency", "defaultCurrencyCountryIsoCode", "enterpriseId" ], "type": "object", "properties": { "taxId": { "type": "string", "description": "Tax ID of the supplier company", "format": "max 35 characters" }, "bankId": { "type": "string", "description": "Visa-issued Business ID (BID) 8 digits or SWIFT BIC of supplier bank", "format": "8-11 characters" }, "address": { "required": [ "countryIsoCode", "line1", "unitNo" ], "type": "object", "properties": { "city": { "type": "string", "description": "City of the Supplier company" }, "line1": { "type": "string", "description": "Address of the supplier company in question; except Unit Number" }, "state": { "type": "string", "description": "State of the supplier company" }, "unitNo": { "type": "string", "description": "Unit Number of the Address field" }, "zipCode": { "type": "string", "description": "Zip Code of the supplier company" }, "countryIsoCode": { "type": "integer", "description": "Valid supported ISO 3166 3-digit numeric country code. Based on couuntry of the Supplier company's address", "format": "3 digits" }, "countryDisplayName": { "type": "string", "description": "Country of the supplier company based on address" } } }, "bankBic": { "type": "string", "description": "SWIFT BIC of the the supplier's bank", "format": "8-11 characters" }, "bankName": { "type": "string", "description": "Bank Name of the Supplier" }, "alphaCode": { "type": "string", "description": "Country of the Supplier Company. Valid supported ISO 3166 3-alpha country code", "format": "3 characters" }, "companyId": { "type": "string", "description": "A unique identifier representing a company relationship to a bank." }, "acctNumber": { "type": "string", "description": "Account number of the Supplier company" }, "ibanNumber": { "type": "string", "description": "IBAN of the Supplier Company.", "format": "1-34 characters" }, "clabeNumber": { "type": "string", "description": "The supplier company's clabe number", "format": "18 digits" }, "companyName": { "type": "string", "description": "The supplier company name" }, "countryName": { "type": "string", "description": "Country of the Supplier Company" }, "enterpriseId": { "type": "string", "description": "Enterprise ID of the Supplier Company. Enterprise ID is assigned to each network-enabled company" }, "routingNumber": { "type": "string", "description": "Routing numner of the supplier company" }, "countryIsoCode": { "type": "integer", "description": "Country ISO code of the Supplier Company. Valid supported ISO 3166 3-alpha country code", "format": "3 characters" }, "registrationId": { "type": "string", "description": "Registration ID of the Supplier Company" }, "defaultCurrency": { "type": "string", "description": "Currency of the supplier company. Valid supported ISO 4217 3-charcter currency code", "format": "3 characters" }, "defaultCurrencyCountryIsoCode": { "type": "string", "description": "Currency ISO code of the supplier company. Valid supported ISO 4217 3-character currecny code", "format": "3 characters" } } }, "startIndex": { "type": "string", "description": "Supports Paganization" }, "totalRecords": { "type": "integer", "description": "Supports Paganization" }, "remaingRecords": { "type": "integer", "description": "Supports Paganization" } }, "description": "Successful request" } } }, "examples": { "Default": { "summary": "Default", "value": { "pagingData": [ { "ibanNumber": "", "address": { "zipCode": 32579, "unitNo": "Unit 20", "city": "Test City", "countryIsoCode": 840, "state": "CA", "line1": "12401 Supplier Test Address", "countryDisplayName": "USA" }, "defaultCurrencyCountryIsoCode": 840, "clabeNumber": "", "countryIsoCode": 840, "companyName": "Supplier Test Company", "bankBic": "LMNOZZEFXXX", "bankName": "Supplier Test Bank", "routingNumber": "089000887", "bankId": "12222225", "companyId": "9999", "acctNumber": "07070077", "taxId": "v2ae197e-7d0e-487f-8829-a1990ccde35f", "defaultCurrency": "USD", "registrationId": "344222900", "countryName": "USA", "enterpriseId": "V-USA-EUR-20373-2342-004", "alphaCode": "USA" }, { "ibanNumber": "", "address": { "zipCode": 21380, "unitNo": "", "city": "Test City", "countryIsoCode": 484, "state": "Baja California", "line1": "Test Supplier Street, 21380, Baja California", "countryDisplayName": "MEXICO" }, "defaultCurrencyCountryIsoCode": 484, "clabeNumber": "138211654543219847", "countryIsoCode": 484, "companyName": "Test Supplier Company", "bankBic": "ABCDUSEFXXX", "bankName": "Test Supplier Bank", "routingNumber": "011075199", "bankId": "52222221", "companyId": "000000049", "acctNumber": "1234560866", "taxId": "577841122", "defaultCurrency": "MXN", "registrationId": "892222900", "countryName": "MEXICO", "enterpriseId": "V-USA-MXN-80373100-100000891-185", "alphaCode": "MEX" } ], "startIndex": "000000039", "totalRecords": 2, "nexturl": "https://qa.vbc.app.visa.com:8443/visab2bconnect/v2/suppliers/EUR?cursor=100002558&reccount=3", "endIndex": "000000089", "remaingRecords": 0, "pageSize": 2, "nextIndex": 100002558 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "errorMessages": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "object" } } } } } } } } } }, "x-operationVersions": [ { "label": "v1 - Latest", "operationPointer": "#/paths/~1visab2bconnect~1v1~1suppliers~1{searchString}/get", "default": false } ], "x-hideTryIt": true } } }, "components": { "schemas": { "companyPaymentsResponse": { "type": "object", "properties": { "paymentId": { "type": "string", "description": "Unique ID for payment as assinged by network" }, "debtorIBAN": { "type": "string", "description": "IBAN of Payer Company (Debtor)", "format": "1-34 characters" }, "debtorName": { "maxLength": 140, "type": "string", "description": "Full Name of Payer Company (Debtor)", "format": "max 140 characters" }, "endToEndID": { "type": "string", "description": "End to End ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as Transaction ID" }, "creditorIBAN": { "type": "string", "description": "IBAN of Beneficiary Company", "format": "1-34 characters" }, "creditorName": { "maxLength": 140, "type": "string", "description": "Full Name of Beneficiary Company (Creditor)", "format": "max 140 characters" }, "exchangeRate": { "type": "number", "description": "The exchange rate, if any", "format": "double" }, "responseList": { "type": "array", "items": { "$ref": "#/components/schemas/responseList01" } }, "serviceLevel": { "type": "string", "description": "Default to Standard. Reserved for future use" }, "creditorTaxID": { "maxLength": 35, "type": "string", "description": "Local Tax ID of Beneficiary Company (Creditor). Country-specific validations apply", "format": "max 25 characters" }, "debtorAddress": { "maxLength": 140, "type": "string", "description": "Full Address of Payer Company (Debtor)", "format": "max 140 characters" }, "debtorCountry": { "type": "string", "description": "Country of Payer Company (Debtor). Valid supported ISO 3166 2-alpha country code", "format": "2 characters" }, "paymentStatus": { "type": "string", "description": "Status of the Payment" }, "transactionID": { "type": "string", "description": "Transaction ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as End to End ID" }, "debtorAgentBic": { "type": "string", "description": "SWIFT BIC of Originating Bank (Debtor Agent)", "format": "8-11 characters" }, "debtorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8 digits of Originating Bank (Debtor Agent)", "format": "8 characters" }, "paymentPurpose": { "type": "string", "description": "Purpose of Payment. Country-specific validations apply" }, "creditorAddress": { "maxLength": 140, "type": "string", "description": "Full Address of Beneficiary Company (Creditor)", "format": "max 140 characters including spaces" }, "creditorCountry": { "type": "string", "description": "Country of Beneficiary Company (Creditor). Valid supported ISO 3166 2-alpha country code", "format": "2 characters" }, "creditorAgentBic": { "type": "string", "description": "SWIFT BIC of Beneficiary Bank (Creditor Agent)", "format": "8-11 characters" }, "creditorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8-digits of Beneficiary Bank (Creditor Agent)", "format": "8 characters" }, "fxTradeRefNumber": { "maxLength": 35, "type": "string", "description": "FX Trade Reference Number, reserved for future use", "format": "max 35 characters" }, "instructedAmount": { "type": "number", "description": "Amount instructed to be delivered to Beneficiary Company (Creditor)", "format": "BigDecimal" }, "settlementAmount": { "type": "number", "description": "Settlement Amout", "format": "BigDecimal" }, "creditorAgentIBAN": { "type": "string", "description": "Account IBAN of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "creditorAgentTaxID": { "maxLength": 35, "type": "string", "description": "Tax ID of Beneficiary Bank (Creditor Agent)" }, "debtorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Payer Company (Debtor). Enterprise ID is assigned to each network-enabled company." }, "instructedCurrency": { "type": "string", "description": "Currency of the Instructed Amount. Valid supported ISO 4217 3-character currency code", "format": "3 characters" }, "paymentCreatedDate": { "type": "string", "description": "Date and time of payment creation", "format": "date" }, "paymentPurposeCode": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code. Country-specific validations apply" }, "settlementCurrency": { "type": "string", "description": "Settlement Currency (ISO 4217 3-alpha currency code)", "format": "3 characters" }, "creditorContactName": { "maxLength": 140, "type": "string", "description": "Contact Name of the Beneficiary Company (Creditor)." }, "debtorAccountNumber": { "type": "string", "description": "Account number of Payer Company (Debtor)" }, "paymentPurposeCode2": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code 2. Country-specific validations apply" }, "creditorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Beneficiary Company (Creditor). Enterprise ID is assigned to reach network-enabled company." }, "structuredRemittance": { "type": "array", "items": { "$ref": "#/components/schemas/structuredRemittance01" } }, "creditorAccountNumber": { "type": "string", "description": "Account Number of Beneficiary Company (Creditor)" }, "creditorAgentBranchID": { "maxLength": 35, "type": "string", "description": "Branch ID of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "expectedSettlementDate": { "type": "string", "description": "Expected date of settlement", "format": "date" }, "unstructuredRemittance": { "type": "string", "description": "Free form remittance, typically corresponds to Originator Information (OBI)" }, "valueAddedTaxIndicator": { "type": "string", "description": "Possible values: INC (VAT Included) or EX (VAT Excluded from payment amount). Applicable to RUB payments to Russia" }, "creditorAgentBranchName": { "maxLength": 140, "type": "string", "description": "Branch Name of the Beneficiary Bank (Creditor Agent)", "format": "max 140 characters" }, "creditorAgentInstruction": { "type": "string", "description": "Any Bank-toBank Information (BBI) populated by Originating Bank (Debtor Agent) for Beneficiary Bank (Creditor Agent)." }, "creditorContactPhoneNumber": { "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$", "type": "string", "description": "Contact phone number for the Beneficiary Company (Creditor). Country-specific validations apply" }, "creditorAgentClearingMemberID": { "maxLength": 35, "type": "string", "description": "Clearing Member ID of Beneficiary Bank (Creditor Agent) e.g. USA ABA number, UK Sort Code, etc.", "format": "max 35 characters" }, "instructingReimbursementAgent": { "type": "string", "description": "Instructing Reimbursement Agent to be used for this payment" } } }, "responseList_13": { "title": "responseList", "type": "array", "items": { "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code" }, "reasonDesc": { "type": "string", "description": "Reason Description" } } } }, "fxRatesCalculatorResponse": { "type": "object", "properties": { "rateId": { "type": "string", "description": "Unique identifier assigned to rate response" }, "requestId": { "type": "string", "description": "Unique identifier for tracking rate request", "format": "up to 35 characters" }, "rateExpiry": { "type": "string", "description": "Exchange Rate is valid until Date and time specified here", "format": "yyyy-mm-ddThh:mm:ss" }, "sourceCurrency": { "type": "string", "description": "Currency of the Originator of the payment (Valid ISO 4217 3-alpha currency code)", "format": "3 characters" }, "targetCurrency": { "type": "string", "description": "Currency of the payment recipient (Valid ISO 4217 3-alpha currency code)", "format": "3 characters" }, "effectiveConversionRate": { "type": "number", "description": "Exchange Rate between Source and Target Currencies", "format": "number(9,5)" }, "effectiveConversionRateWithMarkup": { "type": "number", "description": "Exchange Rate with optional markup applied", "format": "number(9,5)" } } }, "pagingData01_14": { "title": "pagingData01", "required": [ "currency", "customerAccountNumber", "fxRate", "invoiceList", "originatingBankBID", "originatingBankName", "originatingCorporateName", "paymentDateAndTime", "paymentId", "recipientBankBID", "recipientBankName", "recipientCorpName", "statusText", "total" ], "type": "object", "properties": { "type": { "type": "string", "description": "Type of Payment. Possible Values: In Network or Out-of-Network" }, "uetr": { "maxLength": 36, "type": "string", "description": "UETR is unique payment reference for payments sent over SWIFT GPI" }, "total": { "type": "string", "description": "Settlement Amount" }, "fxRate": { "type": "string", "description": "Foreign Exchange Rate", "format": "Double" }, "currency": { "type": "string", "description": "Settlement Currency (ISO 4217 3-alpha currency code), can be used to filter by currency. Blank means all settlement currencies are configured with Visa" }, "paymentId": { "type": "string", "description": "Unique ID for payment as assigned by network" }, "endToEndID": { "type": "string", "description": "End to End ID assigned by Originating Bank (Debtor Agent) during Payment Initiation" }, "statusText": { "type": "string", "description": "Status of the Payment" }, "creditorLEI": { "maxLength": 20, "type": "string", "description": "Legal Entity Identifier (LEI) of a creditor. Country-specific validations apply", "format": "As per character set. Max 20 characters" }, "invoiceList": { "type": "array", "items": { "$ref": "#/components/schemas/invoiceList01_14" } }, "chargeBearer": { "type": "string", "description": "Specify which party will pay charges due for processing of the payment. Possible values are DEBT (charges borne by debtor), CRED (charges borne by Creditor), SHAR (charges shared by debtor and creditor)", "format": "As per character set. Max 4 characters" }, "serviceLevel": { "type": "string", "description": "Default to Standard. Reserved for future use" }, "creditorTaxID": { "type": "string", "description": "Local Tax ID of Beneficiary Company (Creditor)" }, "paymentMethod": { "type": "string", "description": "Method of payment initiation by Originating Bank (Debtor Agent)" }, "paymentStatus": { "type": "string", "description": "Status of Payment" }, "transactionID": { "type": "string", "description": "Unique ID assigned by Originating Bank (Debtor Agent) during Payment Initiation" }, "paymentPurpose": { "type": "string", "description": "Purpose of Payment" }, "recipientBankBIC": { "type": "string", "description": "SWIFT BIC of Beneficiary Bank (Creditor Agent)", "format": "8-11 characters" }, "recipientBankBID": { "type": "string", "description": "Visa-issued Business ID (BID) of Beneficiary Bank (Creditor Agent)", "format": "8 characters" }, "creditorAgentIBAN": { "type": "string", "description": "Account IBAN of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "recipientBankName": { "type": "string", "description": "Name of Beneficiary Bank (Creditor Agent)" }, "recipientCorpName": { "type": "string", "description": "Name of Beneficiary Company (Creditor)" }, "creditorAgentTaxID": { "type": "string", "description": "Tax ID of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "originatingBankBIC": { "type": "string", "description": "SWIFT BIC of Originating Bank (Debtor Agent)", "format": "8-11 characters" }, "originatingBankBID": { "type": "string", "description": "Visa-issued Business ID (BID) of Originating Bank (Debtor Agent).", "format": "8 characters" }, "paymentDateAndTime": { "type": "string", "description": "Payment execution date and time", "format": "date, time" }, "paymentPurposeCode": { "type": "string", "description": "Purpose of Payment Code", "format": "max 35 characters" }, "senderEnterpriseId": { "type": "string", "description": "Enterprise ID of Payer Company (Debtor). Enterprise ID is assigned to each network-enabled company." }, "creditorContactName": { "maxLength": 140, "type": "string", "description": "Contact Name of the Beneficiary Company (Creditor)" }, "loanReferenceNumber": { "maxLength": 35, "type": "string", "description": "The reference number associated with a loan. Country-specific validations apply", "format": "As per character set. Max 35 characters" }, "originatingBankName": { "type": "string", "description": "Name of Originating Bank (Debtor Agent)" }, "paymentPurposeCode2": { "type": "string", "description": "Purpose of Payment Code 2", "format": "max 35 characters" }, "actualSettlementDate": { "type": "string", "description": "Actual date of settlement", "format": "date" }, "intermediaryAgentBic": { "type": "string", "description": "Intermediary Agent BIC .", "format": "BIC Standard format. 8-11 characters" }, "receiverEnterpriseId": { "type": "string", "description": "Enterprise ID of Beneficiary Company (Creditor). Enterprise ID is assigned to each network-enabled company." }, "creditorAgentBranchID": { "type": "string", "description": "Branch ID of Beneficiary Bank (Creditor Agent)" }, "customerAccountNumber": { "type": "string", "description": "Account number of Beneficiary Company (Creditor)" }, "intermediaryAgentName": { "type": "string", "description": "Intermediary Agent's Name ", "format": "As per character set" }, "debtorAgentCountryCode": { "type": "string", "description": "The country code type of the non bic asociated debtor bank" }, "expectedSettlementDate": { "type": "string", "description": "Expected date of settlement", "format": "date" }, "fxTradeReferenceNumber": { "type": "string", "description": "FX Trade Reference number" }, "unstructuredRemittance": { "type": "string", "description": "Free form remittance entered during Payment Initiation, typically corresponds to Originator-to-Beneficiary Information (OBI)" }, "valueAddedTaxIndicator": { "type": "string", "description": "Possible values: INC (VAT Included) or EX (VAT excluded). Applicable to RUB payments to Russia." }, "creditorAgentBranchName": { "type": "string", "description": "Branch Name of Beneficiary Bank (Creditor Agent)" }, "creditorAgentCountryCode": { "maxLength": 45, "type": "string", "description": "Country Code of Beneficiary Bank (Creditor Agent)", "format": "IBAN Standard Format. 1-45 characters" }, "creditorAgentInstruction": { "type": "string", "description": "Any Bank to Bank Information (BBI) populated by Originating Bank (Debtor Agent) for Beneficiary Bank (Creditor Agent) is returned here." }, "intermediaryAgentAddress": { "type": "string", "description": "Intermediary Agent's Address", "format": "As per character set" }, "intermediaryAgentCountry": { "type": "string", "description": "Intermediary Agent's Country", "format": "As per character set" }, "originatingCorporateName": { "type": "string", "description": "Name of Payer Company (Debtor)" }, "creditorContactPhoneNumber": { "type": "string", "description": "Phone number of Beneficiary Company (Creditor)" }, "debtorAgentClearingMemberID": { "type": "string", "description": "The clearing member id of the non bic asociated debtor bank" }, "creditorAgentClearingMemberID": { "maxLength": 35, "type": "string", "description": "Clearing Member ID of Beneficiary Bank (Creditor Agent) e.g. USA ABA number, UK Sort Code, etc.", "format": "As per character set." }, "instructingReimbursementAgent": { "type": "string", "description": "Instructing Reimbursement Agent used during Payment Initiation" }, "debtorAgentClearingMemberIDType": { "type": "string", "description": "The clearing member id type of the non bic asociated debtor bank" }, "creditorAgentClearingMemberIDType": { "maxLength": 35, "type": "string", "description": "Clearing Member ID Type of Beneficiary Bank (Creditor Agent) ", "format": "IBAN Standard Format. 1-35 characters" } } }, "structuredRemittance01": { "type": "object", "properties": { "poNumber": { "type": "string", "description": "PO Nunber for the payment" }, "invoiceNotes": { "type": "string", "description": "Notes for the Payment" }, "invoiceNumber": { "type": "string", "description": "Invoice Number for the payment" }, "partialPayment": { "type": "boolean", "description": "Return True if it is a partial payment. Returns False if it is not a partial payment" } } }, "companyPaymentsResponse_13": { "title": "companyPaymentsResponse", "type": "object", "properties": { "type": { "type": "string", "description": "Type of Payment. Possible Values: In Network or Out-of-Network" }, "paymentId": { "type": "string", "description": "Unique ID for payment as assinged by network" }, "debtorIBAN": { "maxLength": 35, "type": "string", "description": "IBAN of Payer Company (Debtor)", "format": "IBAN Standard Format. 1-34 characters" }, "debtorName": { "maxLength": 140, "type": "string", "description": "Full Name of Payer Company (Debtor)", "format": "As per character set." }, "endToEndID": { "maxLength": 35, "type": "string", "description": "End to End ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as Transaction ID", "format": "As per character set" }, "chargeBearer": { "type": "string", "description": "Specify which party will pay charges due for processing of the payment. Possible values are DEBT (charges borne by debtor), CRED (charges borne by Creditor), SHAR (charges shared by debtor and creditor)", "format": "As per character set. Max 4 characters" }, "creditorIBAN": { "maxLength": 35, "type": "string", "description": "IBAN of Beneficiary Company", "format": "IBAN Standard format. 1-34 characters" }, "creditorName": { "maxLength": 140, "minLength": 3, "type": "string", "description": "Full Name of Beneficiary Company (Creditor)", "format": "As per character set." }, "exchangeRate": { "type": "number", "description": "The exchange rate, if any", "format": "double" }, "responseList": { "type": "array", "items": { "$ref": "#/components/schemas/responseList01_13" } }, "serviceLevel": { "maxLength": 35, "type": "string", "description": "Default to Standard. Reserved for future use", "format": "As per character set" }, "creditorTaxID": { "maxLength": 35, "type": "string", "description": "Local Tax ID of Beneficiary Company (Creditor). Country-specific validations apply", "format": "As per character set." }, "debtorAddress": { "maxLength": 140, "type": "string", "description": "Full Address of Payer Company (Debtor)", "format": "As per character set." }, "debtorCountry": { "type": "string", "description": "Country of Payer Company (Debtor). Valid supported ISO 3166 2-alpha country code", "format": "ISO 2-alpha code" }, "paymentStatus": { "type": "string", "description": "Status of the Payment" }, "transactionID": { "maxLength": 35, "type": "string", "description": "Unique ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as End to End ID", "format": "As per character set" }, "debtorAgentBic": { "type": "string", "description": "SWIFT BIC of Originating Bank (Debtor Agent)", "format": "BIC Standard format. 8-11 characters" }, "debtorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8 digits of Originating Bank (Debtor Agent)", "format": "As per character set. 8 characters" }, "paymentPurpose": { "maxLength": 35, "minLength": 3, "type": "string", "description": "Purpose of Payment. Country-specific validations apply", "format": "As per character set" }, "creditorAddress": { "maxLength": 140, "minLength": 5, "type": "string", "description": "Full Address of Beneficiary Company (Creditor)", "format": "As per character set." }, "creditorCountry": { "type": "string", "description": "Country of Beneficiary Company (Creditor). Valid supported ISO 3166 2-alpha country code", "format": "ISO 2-alpha code" }, "creditorAgentBic": { "type": "string", "description": "SWIFT BIC of Beneficiary Bank (Creditor Agent)", "format": "BIC Standard format. 8-11 characters" }, "creditorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8-digits of Beneficiary Bank (Creditor Agent)", "format": "As per character set. 8 characters" }, "fxTradeRefNumber": { "maxLength": 35, "type": "string", "description": "FX Trade Reference Number", "format": "Alpha numeric" }, "instructedAmount": { "type": "number", "description": "Amount instructed to be delivered to Beneficiary Company (Creditor)", "format": "Number" }, "settlementAmount": { "type": "number", "description": "Settlement Amout", "format": "BigDecimal" }, "creditorAgentIBAN": { "maxLength": 35, "type": "string", "description": "Account IBAN of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "creditorAgentTaxID": { "maxLength": 35, "type": "string", "description": "Tax ID of Beneficiary Bank (Creditor Agent)" }, "debtorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Payer Company (Debtor). Enterprise ID is assigned to each network-enabled company.", "format": "As per character set" }, "instructedCurrency": { "maxLength": 3, "type": "string", "description": "Currency of the Instructed Amount. Valid supported ISO 4217 3-character currency code", "format": "ISO 3-alpha code" }, "paymentCreatedDate": { "type": "string", "description": "Date and time of payment creation", "format": "date" }, "paymentPurposeCode": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code. Country-specific validations apply", "format": "As per character set" }, "settlementCurrency": { "type": "string", "description": "Settlement Currency (ISO 4217 3-alpha currency code)", "format": "3 characters" }, "creditorContactName": { "maxLength": 140, "minLength": 3, "type": "string", "description": "Contact Name of the Beneficiary Company (Creditor)." }, "debtorAccountNumber": { "maxLength": 35, "type": "string", "description": "Account number of Payer Company (Debtor)", "format": "As per character set" }, "paymentPurposeCode2": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code 2. Country-specific validations apply", "format": "As per character set" }, "creditorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Beneficiary Company (Creditor). Enterprise ID is assigned to reach network-enabled company.", "format": "As per character set" }, "intermediaryAgentBic": { "type": "string", "description": "Intermediary Agent BIC .", "format": "BIC Standard format. 8-11 characters" }, "structuredRemittance": { "type": "array", "items": { "$ref": "#/components/schemas/structuredRemittance01_13" } }, "creditorAccountNumber": { "maxLength": 35, "type": "string", "description": "Account Number of Beneficiary Company (Creditor)", "format": "As per character set" }, "creditorAgentBranchID": { "maxLength": 35, "minLength": 3, "type": "string", "description": "Branch ID of Beneficiary Bank (Creditor Agent)", "format": "As per character set." }, "intermediaryAgentName": { "type": "string", "description": "Intermediary Agent's Name ", "format": "As per character set" }, "expectedSettlementDate": { "type": "string", "description": "Expected date of settlement", "format": "date" }, "unstructuredRemittance": { "maxLength": 140, "type": "string", "description": "Free form remittance, typically corresponds to Originator Information (OBI)", "format": "As per character set" }, "valueAddedTaxIndicator": { "type": "string", "description": "Possible values: INC (VAT Included) or EX (VAT Excluded from payment amount). Applicable to RUB payments to Russia", "format": "INC or EX" }, "creditorAgentBranchName": { "maxLength": 140, "minLength": 3, "type": "string", "description": "Branch Name of the Beneficiary Bank (Creditor Agent)", "format": "As per character set." }, "creditorAgentCountryCode": { "maxLength": 45, "type": "string", "description": "Country Code of Beneficiary Bank (Creditor Agent)", "format": "IBAN Standard Format. 1-45 characters" }, "creditorAgentInstruction": { "maxLength": 140, "type": "string", "description": "Any Bank-toBank Information (BBI) populated by Originating Bank (Debtor Agent) for Beneficiary Bank (Creditor Agent).", "format": "As per character set" }, "intermediaryAgentAddress": { "type": "string", "description": "Intermediary Agent's Address", "format": "As per character set" }, "intermediaryAgentCountry": { "type": "string", "description": "Intermediary Agent's Country", "format": "As per character set" }, "creditorContactPhoneNumber": { "maxLength": 20, "minLength": 3, "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$", "type": "string", "description": "Contact phone number for the Beneficiary Company (Creditor). Country-specific validations apply", "format": "Phone number format. Include + ( ) -" }, "debtorAgentClearingMemberID": { "type": "string", "description": "Clearing Member Id of the Debtor Agent non-bic associated bank. This is required if the BIC and BID are not provided." }, "creditorAgentClearingMemberID": { "maxLength": 35, "type": "string", "description": "Clearing Member ID of Beneficiary Bank (Creditor Agent) e.g. USA ABA number, UK Sort Code, etc.", "format": "As per character set." }, "instructingReimbursementAgent": { "type": "string", "description": "Instructing Reimbursement Agent to be used for this payment", "format": "BIC Standard Format" }, "debtorAgentClearingMemberIDType": { "type": "string", "description": "Clearing Member Id type of the Debtor Agent non-bic associated bank. This is required if the BIC and BID are not provided." }, "creditorAgentClearingMemberIDType": { "maxLength": 35, "type": "string", "description": "Clearing Member ID Type of Beneficiary Bank (Creditor Agent) ", "format": "IBAN Standard Format. 1-35 characters" } } }, "errorMessages_14": { "title": "errorMessages", "type": "array", "description": "Displays error messages, if any", "items": { "type": "string", "description": "Display error codes and descriptions, if any" } }, "errorMessages_15": { "title": "errorMessages", "type": "array", "description": "Displays error messages, if any", "items": { "type": "string", "description": "Display error codes and descriptions, if any" } }, "errorMessages_13": { "title": "errorMessages", "type": "array", "description": "Displays error messages, if any", "items": { "type": "string", "description": "Display error codes and descriptions, if any" } }, "companySearchPaymentsResponse01": { "type": "array", "items": { "$ref": "#/components/schemas/companySearchPaymentsResponse01" } }, "companyPaymentsRequest_13": { "title": "companyPaymentsRequest", "required": [ "creditorAccountNumber", "creditorAgentBid", "debtorAccountNumber", "debtorAgentBid", "endToEndID", "instructedAmount", "instructedCurrency", "transactionID" ], "type": "object", "properties": { "debtorIBAN": { "maxLength": 35, "type": "string", "description": "IBAN of Payer Company (Debtor). (Mandatory if debtorEnterpriseId or debtorAccountNumber is not provided)", "format": "IBAN Standard Format. 1-34 characters" }, "debtorName": { "maxLength": 140, "type": "string", "description": "Full Name of Payer Company (Debtor) Mandatory if debtorEnterpriseId is not provided", "format": "As per character set." }, "endToEndID": { "maxLength": 35, "type": "string", "description": "End to End ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as Transaction ID", "format": "As per character set" }, "creditorLEI": { "maxLength": 20, "type": "string", "description": "Legal Entity Identifier (LEI) of a creditor. Country-specific validations apply", "format": "As per character set. Max 20 characters" }, "chargeBearer": { "type": "string", "description": "Specify which party will pay charges due for processing of the payment. Possible values are DEBT (charges borne by debtor), CRED (charges borne by Creditor), SHAR (charges shared by debtor and creditor)", "format": "As per character set. Max 4 characters" }, "creditorIBAN": { "maxLength": 35, "type": "string", "description": "IBAN of Beneficiary Company (Creditor) (Mandatory if CreditorEnterpriseId or creditorAccountNumber is not provided)", "format": "IBAN Standard Format. 1-34 characters" }, "creditorName": { "maxLength": 140, "minLength": 3, "type": "string", "description": "Full Name of Beneficiary Company (Creditor) Mandatory if creditorEnterpriseId is not provided", "format": "As per character set." }, "serviceLevel": { "maxLength": 35, "type": "string", "description": "Default to Standard.", "format": "As per character set" }, "creditorTaxID": { "maxLength": 35, "type": "string", "description": "Local Tax ID of Beneficiary Company (Creditor). Country-specific validations apply", "format": "As per character set. Max 35 characters" }, "debtorAddress": { "maxLength": 140, "type": "string", "description": "Full Address of Payer Company (Debtor) Mandatory if debtorEnterpriseId is not provided", "format": "As per character set." }, "debtorCountry": { "type": "string", "description": "Country of Payer Company (Debtor). Valid supported ISO 3166 2-alpha country code", "format": "ISO 2-alpha code" }, "transactionID": { "maxLength": 35, "type": "string", "description": "Unique ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as End to End ID", "format": "As per character set" }, "debtorAgentBic": { "type": "string", "description": "SWIFT BIC of Originating Bank (Debtor Agent) (Mandatory if debtorAgentBid or debtorAgentClearingMemberID is not provided)", "format": "BIC Standard format. 8-11 characters" }, "debtorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8 digits of Originating Bank (Debtor Agent) (Mandatory if debtorAgentBic is not provided)", "format": "As per character set. 8 characters" }, "paymentPurpose": { "maxLength": 35, "minLength": 3, "type": "string", "description": "Purpose of Payment. Country-specific validations apply", "format": "As per character set" }, "creditorAddress": { "maxLength": 140, "minLength": 5, "type": "string", "description": "Full Address of Beneficiary Company (Creditor) Mandatory if creditorEnterpriseId is not provided", "format": "As per character set. Max 140 characters including spaces" }, "creditorCountry": { "type": "string", "description": "Country of Beneficiary Company (Creditor). Valid supported ISO 3166 2-alpha country code", "format": "ISO 2-alpha code" }, "creditorAgentBic": { "type": "string", "description": "SWIFT BIC of Beneficiary Bank (Creditor Agent) (Mandatory if creditorAgentBid is not provided)", "format": "BIC Standard Format. 8-11 characters" }, "creditorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8-digits of Beneficiary Bank (Creditor Agent) (Mandatory if creditorAgentBic is not provided)", "format": "As per character set. 8 characters" }, "fxTradeRefNumber": { "maxLength": 35, "type": "string", "description": "FX Trade Reference Number", "format": "Alpha numeric. Max 35 characters" }, "instructedAmount": { "type": "number", "description": "Amount instructed to be delivered to Beneficiary Company (Creditor)", "format": "Number" }, "creditorAgentIBAN": { "type": "string", "description": "Account IBAN of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "creditorAgentTaxID": { "maxLength": 35, "type": "string", "description": "Tax ID of Beneficiary Bank (Creditor Agent)" }, "debtorEnterpriseId": { "type": "string", "description": "Enterprise ID of Payer Company (Debtor). Enterprise ID is assigned to each network-enabled company. (Mandatory if or debtorAccountNumber is not provided)" }, "instructedCurrency": { "maxLength": 3, "type": "string", "description": "Currency of the Instructed Amount. Valid supported ISO 4217 3-character currency code", "format": "ISO 3-alpha code" }, "paymentPurposeCode": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code. Country-specific validations apply", "format": "As per character set" }, "creditorContactName": { "maxLength": 140, "minLength": 3, "type": "string", "description": "Contact Name of the Beneficiary Company (Creditor)." }, "debtorAccountNumber": { "maxLength": 35, "type": "string", "description": "Account number of Payer Company (Debtor). (Mandatory if debtorIBAN or debtorEnterpriseId is not provided)", "format": "As per character set" }, "loanReferenceNumber": { "maxLength": 35, "type": "string", "description": "The reference number associated with a loan. Country-specific validations apply", "format": "As per character set. Max 35 characters" }, "paymentPurposeCode2": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code 2. Country-specific validations apply", "format": "As per character set" }, "creditorEnterpriseId": { "type": "string", "description": "Enterprise ID of Beneficiary Company (Creditor). Enterprise ID is assigned to reach network-enabled company. (Mandatory if creditorIBAN or creditorAccountNumber is not provided)", "format": "As per character set" }, "intermediaryAgentBic": { "type": "string", "description": "Intermediary Agent BIC .", "format": "BIC Standard format. 8-11 characters" }, "structuredRemittance": { "type": "array", "items": { "$ref": "#/components/schemas/structuredRemittance01_13" } }, "creditorAccountNumber": { "maxLength": 35, "type": "string", "description": "Account Number of Beneficiary Company (Creditor) (Mandatory if creditorIBAN or CreditorEnterpriseId is not provided)", "format": "As per character set" }, "creditorAgentBranchID": { "maxLength": 35, "minLength": 3, "type": "string", "description": "Branch ID of Beneficiary Bank (Creditor Agent)", "format": "As per character set. Max 35 characters" }, "unstructuredRemittance": { "maxLength": 140, "type": "string", "description": "Free form remittance, typically corresponds to Originator-to-Beneficiary Information (OBI)", "format": "As per character set" }, "valueAddedTaxIndicator": { "type": "string", "description": "Possible values: INC (VAT Included) or EX (VAT Excluded from payment amount). Applicable to RUB payments to Russia", "format": "INC or EX" }, "creditorAgentBranchName": { "maxLength": 140, "minLength": 3, "type": "string", "description": "Branch Name of the Beneficiary Bank (Creditor Agent)", "format": "As per character set." }, "creditorAgentCountryCode": { "maxLength": 45, "type": "string", "description": "Country Code of Beneficiary Bank (Creditor Agent)", "format": "IBAN Standard Format. 1-45 characters" }, "creditorAgentInstruction": { "type": "string", "description": "Any Bank-toBank Information (BBI) populated by Originating Bank (Debtor Agent) for Beneficiary Bank (Creditor Agent).", "format": "As per character set" }, "creditorContactPhoneNumber": { "maxLength": 20, "minLength": 3, "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$", "type": "string", "description": "Contact phone number for the Beneficiary Company (Creditor). Country-specific validations apply", "format": "Phone Number format. Include the following characters: + ( ) -" }, "debtorAgentClearingMemberID": { "type": "string", "description": "Clearing Member Id of the Debtor Agent non-bic associated bank. This is required if the debtorAgentBic and debtorAgentBid are not provided." }, "creditorAgentClearingMemberID": { "maxLength": 35, "type": "string", "description": "Clearing Member ID of Beneficiary Bank (Creditor Agent) e.g. USA ABA number, UK Sort Code, etc.", "format": "Alpha numeric. Max 35 characters" }, "instructingReimbursementAgent": { "type": "string", "description": "Instructing Reimbursement Agent to be used for this payment", "format": "BIC standard format" }, "debtorAgentClearingMemberIDType": { "type": "string", "description": "Clearing Member Id type of the Debtor Agent non-bic associated bank. This is required if the debtorAgentClearingMemberID is not provided." }, "creditorAgentClearingMemberIDType": { "maxLength": 35, "type": "string", "description": "Clearing Member ID Type of Beneficiary Bank (Creditor Agent) ", "format": "IBAN Standard Format. 1-35 characters" } } }, "structuredRemittance01_13": { "title": "structuredRemittance01", "type": "object", "properties": { "poNumber": { "maxLength": 20, "type": "string", "description": "PO Nunber for the payment", "format": "As per character set" }, "invoiceNotes": { "maxLength": 500, "type": "string", "description": "Notes for the Payment", "format": "As per character set" }, "invoiceNumber": { "maxLength": 20, "type": "string", "description": "Invoice Number for the payment", "format": "As per character set" }, "partialPayment": { "type": "boolean", "description": "Return True if it is a partial payment. Returns False if it is not a partial payment", "format": "Boolean" } } }, "fxRatesCalculatorResponse-1": { "type": "object", "properties": { "markup": { "type": "number", "description": "Optional markup to be applied to exchange rate in response. Must be a positive decimal value with a maximum of 4 integers and 5 decimal places. Min is 0.00001 (basis points).", "format": "number(9,5)" }, "rateId": { "type": "string", "description": "Unique identifier assigned to rate response" }, "requestId": { "type": "string", "description": "Unique identifier for tracking rate request", "format": "up to 35 characters" }, "rateExpiry": { "type": "string", "description": "Exchange Rate is valid until Date and time specified here", "format": "yyyy-mm-ddThh:mm:ss" }, "sourceCurrency": { "type": "string", "description": "Currency of the Originator of the payment (Valid ISO 4217 3-alpha currency code)", "format": "3 characters" }, "targetCurrency": { "type": "string", "description": "Currency of the payment recipient (Valid ISO 4217 3-alpha currency code)", "format": "3 characters" }, "effectiveConversionRate": { "type": "number", "description": "Exchange Rate between Source and Target Currencies", "format": "number(9,5)" }, "effectiveConversionRateWithMarkup": { "type": "number", "description": "Exchange Rate with optional markup applied", "format": "number(9,5)" } } }, "invoiceList01_14": { "title": "invoiceList01", "required": [ "invoiceNumber", "notes", "partialPayment", "paymentAmount", "paymentCurrencyIsoCode", "poNumber" ], "type": "object", "properties": { "notes": { "type": "string", "description": "Notes for the Payment" }, "poNumber": { "type": "string", "description": "PO Nunber for the payment" }, "invoiceNumber": { "type": "string", "description": "Invoice Number for the payment" }, "paymentAmount": { "type": "number", "description": "The Amount of the invoice or Instructed Amount", "format": "double" }, "partialPayment": { "type": "boolean", "description": "Return True if it is a partial payment. Returns False if it is not a partial payment" }, "paymentCurrency": { "type": "string", "description": "Instructed Currency (Valid supported ISO 4217 3-digit character currency code)", "format": "3 characters" }, "paymentCurrencyIsoCode": { "type": "integer", "description": "Instructed Currency (Valid supported ISO 4217 3-digit numberic currency code)", "format": "3 characters" } } }, "paymentEligibilityRequest_15": { "title": "paymentEligibilityRequest", "required": [ "creditorAccountNumber", "creditorBankBic", "debtorAccountNumber", "debtorBankBic", "settlementCurrency" ], "type": "object", "properties": { "debtorIBAN": { "type": "string", "description": "IBAN of Payer Company. (Mandatory if debtorEnterpriseId or debtorAccountNumber is not provided)", "format": "1-34 characters" }, "creditorIBAN": { "type": "string", "description": "IBAN of Beneficiary Company (Mandatory if creditorEnterpriseId or creditorAccountNumber is not provided)", "format": "1-34 characters" }, "debtorBankBic": { "type": "string", "description": "SWIFT BIC of Originating Bank (Debtor Agent)", "format": "8-11 characters" }, "debtorCountry": { "type": "string", "description": "Country Code of Payer Company (Debtor) Valid supported ISO 3166 2-alpha country code", "format": "2 characters" }, "creditorBankBic": { "type": "string", "description": "SWIFT BIC of Beneficiary Bank (Creditor Agent)", "format": "8-11 characters" }, "creditorCountry": { "type": "string", "description": "Country Code of Beneficiary Company (Creditor) Valid supported ISO 3166 2-alpha country code", "format": "2 characters" }, "settlementAmount": { "type": "number", "description": "Amount Instructed to be delivered to Beneficiary Company (Creditor)", "format": "BigDecimal" }, "debtorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Payer Company (Debtor). Enterprise ID is assigned to each network-enabled company. (Mandatory if debtorIBAN or debtorAccountNumber is not provided)" }, "settlementCurrency": { "type": "string", "description": "Currency of Instructed Amount (Valid supported USI 4217 3-character currency code)", "format": "3 characters" }, "debtorAccountNumber": { "type": "string", "description": "Account Number of Payer Company. (Mandatory if debtorEnterpriseId or debtorIBAN is not provided)", "format": "detokenized" }, "creditorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Beneficiary Company (Creditor). Enterprise ID is assigned to each network-enabled company. (Mandatory if creditorIBAN or creditorAccountNumber is not provided)" }, "intermediaryAgentBic": { "type": "string", "description": "Intermediary Agent BIC .", "format": "BIC Standard format. 8-11 characters" }, "creditorAccountNumber": { "type": "string", "description": "Account Number of Beneficiary Company (Mandatory if creditorEnterpriseId or creditorIBAN is not provided)", "format": "1-34 characters" }, "creditorAgentCountryCode": { "maxLength": 45, "type": "string", "description": "Country Code of Beneficiary Bank (Creditor Agent)", "format": "IBAN Standard Format. 1-45 characters" }, "debtorAgentClearingMemberID": { "type": "string", "description": "Clearing Member Id of the Debtor Agent non-bic associated bank. This is required if the debtorBankBic is not provided." }, "creditorAgentClearingMemberID": { "maxLength": 35, "type": "string", "description": "Clearing Member ID of Beneficiary Bank (Creditor Agent) e.g. USA ABA number, UK Sort Code, etc.", "format": "As per character set." }, "debtorAgentClearingMemberIDType": { "type": "string", "description": "Clearing Member Id type of the Debtor Agent non-bic associated bank. This is required if the debtorAgentClearingMemberID is not provided." }, "creditorAgentClearingMemberIDType": { "maxLength": 35, "type": "string", "description": "Clearing Member ID Type of Beneficiary Bank (Creditor Agent) ", "format": "IBAN Standard Format. 1-35 characters" } } }, "responseList01_13": { "title": "responseList01", "required": [ "reasonCode", "reasonDesc" ], "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code" }, "reasonDesc": { "type": "string", "description": "Reason Description" } } }, "responseList01_15": { "title": "responseList01", "required": [ "reasonCode", "reasonDesc" ], "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code" }, "reasonDesc": { "type": "string", "description": "Reason Description" } } }, "responseMessage_13": { "title": "responseMessage", "type": "object", "properties": { "errorMessages": { "$ref": "#/components/schemas/errorMessages_13" } } }, "errorMessages": { "type": "array", "description": "Displays error messages, if any", "items": { "type": "string", "description": "Display error codes and descriptions, if any" } }, "responseMessage_14": { "title": "responseMessage", "type": "object", "properties": { "errorMessages": { "$ref": "#/components/schemas/errorMessages_14" } } }, "paymentEligibilityResponse_15": { "title": "paymentEligibilityResponse", "type": "object", "properties": { "type": { "type": "string", "description": "Type of Payment. Possible Values: In Network or Out-of-Network" }, "responseList": { "type": "array", "items": { "$ref": "#/components/schemas/responseList01_15" } }, "debtorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Payer Company (Debtor). Enterprise ID is assigned to each network-enabled company." }, "creditorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Beneficiary Company (Creditor). Enterprise ID is assigned to each network-enabled company." } } }, "responseMessage_15": { "title": "responseMessage", "type": "object", "properties": { "errorMessages": { "$ref": "#/components/schemas/errorMessages_15" } } }, "responseList": { "type": "array", "items": { "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code" }, "reasonDesc": { "type": "string", "description": "Reason Description" } } } }, "responseList01": { "required": [ "reasonCode", "reasonDesc" ], "type": "object", "properties": { "reasonCode": { "type": "string", "description": "Reason Code" }, "reasonDesc": { "type": "string", "description": "Reason Description" } } }, "companySearchPaymentsResponse_14": { "title": "companySearchPaymentsResponse", "type": "object", "properties": { "nexturl": { "type": "string", "description": "Next Page's Endpoint Resource to Supports Paganization" }, "endIndex": { "type": "string", "description": "Supports Paganization" }, "pageSize": { "type": "integer", "description": "Supports Paganization", "format": "int64" }, "nextIndex": { "type": "string", "description": "Supports Paganization" }, "pagingData": { "type": "array", "items": { "$ref": "#/components/schemas/pagingData01_14" } }, "startIndex": { "type": "string", "description": "Supports Paganization" }, "totalRecords": { "type": "integer", "description": "Supports Paganization", "format": "int64" }, "remainingRecords": { "type": "string", "description": "Supports Paganization" } } }, "responseMessage": { "type": "object", "properties": { "errorMessages": { "$ref": "#/components/schemas/errorMessages" } } }, "companyPaymentsRequest": { "required": [ "creditorAccountNumber", "creditorAgentBid", "debtorAccountNumber", "debtorAgentBid", "endToEndID", "instructedAmount", "instructedCurrency", "transactionID" ], "type": "object", "properties": { "debtorIBAN": { "type": "string", "description": "IBAN of Payer Company (Debtor). (Mandatory if debtorEnterpriseId or debtorAccountNumber is not provided)", "format": "1-34 characters" }, "debtorName": { "maxLength": 140, "type": "string", "description": "Full Name of Payer Company (Debtor)", "format": "max 140 characters including spaces" }, "endToEndID": { "type": "string", "description": "End to End ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as Transaction ID" }, "creditorIBAN": { "type": "string", "description": "IBAN of Beneficiary Company (Creditor) (Mandatory if CreditorEnterpriseId or creditorAccountNumber is not provided)", "format": "1-34 characters" }, "creditorName": { "maxLength": 140, "type": "string", "description": "Full Name of Beneficiary Company (Creditor)", "format": "max 140 characters" }, "serviceLevel": { "type": "string", "description": "Default to Standard. Reserved for future use" }, "creditorTaxID": { "maxLength": 35, "type": "string", "description": "Local Tax ID of Beneficiary Company (Creditor). Country-specific validations apply", "format": "max 35 characters" }, "debtorAddress": { "maxLength": 140, "type": "string", "description": "Full Address of Payer Company (Debtor)", "format": "max 140 characters" }, "debtorCountry": { "type": "string", "description": "Country of Payer Company (Debtor). Valid supported ISO 3166 2-alpha country code", "format": "2 characters" }, "transactionID": { "type": "string", "description": "Transaction ID assigned by Originating Bank (Debtor Agent). If not available this can have the same value as End to End ID" }, "debtorAgentBic": { "type": "string", "description": "SWIFT BIC of Originating Bank (Debtor Agent) (Mandatory if debtorAgentBid is not provided)", "format": "8-11 characters" }, "debtorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8 digits of Originating Bank (Debtor Agent) (Mandatory if debtorAgentBic is not provided)", "format": "8 characters" }, "paymentPurpose": { "type": "string", "description": "Purpose of Payment. Country-specific validations apply" }, "creditorAddress": { "maxLength": 140, "type": "string", "description": "Full Address of Beneficiary Company (Creditor)", "format": "max 140 characters including spaces" }, "creditorCountry": { "type": "string", "description": "Country of Beneficiary Company (Creditor). Valid supported ISO 3166 2-alpha country code", "format": "2 characters" }, "creditorAgentBic": { "type": "string", "description": "SWIFT BIC of Beneficiary Bank (Creditor Agent) (Mandatory if creditorAgentBid is not provided)", "format": "8-11 characters" }, "creditorAgentBid": { "type": "string", "description": "Visa-issued Business ID (BID) 8-digits of Beneficiary Bank (Creditor Agent) (Mandatory if creditorAgentBic is not provided)", "format": "8 characters" }, "fxTradeRefNumber": { "maxLength": 35, "type": "string", "description": "FX Trade Reference Number, reserved for future use", "format": "max 35 characters" }, "instructedAmount": { "type": "number", "description": "Amount instructed to be delivered to Beneficiary Company (Creditor)", "format": "BigDecimal" }, "creditorAgentIBAN": { "type": "string", "description": "Account IBAN of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "creditorAgentTaxID": { "maxLength": 35, "type": "string", "description": "Tax ID of Beneficiary Bank (Creditor Agent)" }, "debtorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Payer Company (Debtor). Enterprise ID is assigned to each network-enabled company. (Mandatory if debtorIBAN or debtorAccountNumber is not provided)" }, "instructedCurrency": { "type": "string", "description": "Currency of the Instructed Amount. Valid supported ISO 4217 3-character currency code", "format": "3 characters" }, "paymentPurposeCode": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code. Country-specific validations apply" }, "creditorContactName": { "maxLength": 140, "type": "string", "description": "Contact Name of the Beneficiary Company (Creditor)." }, "debtorAccountNumber": { "type": "string", "description": "Account number of Payer Company (Debtor). (Mandatory if debtorIBAN or debtorEnterpriseId is not provided)" }, "paymentPurposeCode2": { "maxLength": 35, "type": "string", "description": "Purpose of Payment Code 2. Country-specific validations apply" }, "creditorEnterpriseId": { "pattern": "^[A-Z]{1}-[A-Z]{3}-[A-Z]{3}-\\d{8}-\\d{9}-\\d{3}$", "type": "string", "description": "Enterprise ID of Beneficiary Company (Creditor). Enterprise ID is assigned to reach network-enabled company. (Mandatory if creditorIBAN or creditorAccountNumber is not provided)" }, "structuredRemittance": { "type": "array", "items": { "$ref": "#/components/schemas/structuredRemittance01" } }, "creditorAccountNumber": { "type": "string", "description": "Account Number of Beneficiary Company (Creditor) (Mandatory if creditorIBAN or CreditorEnterpriseId is not provided)" }, "creditorAgentBranchID": { "maxLength": 35, "type": "string", "description": "Branch ID of Beneficiary Bank (Creditor Agent)", "format": "max 35 characters" }, "unstructuredRemittance": { "type": "string", "description": "Free form remittance, typically corresponds to Originator-to-Beneficiary Information (OBI)" }, "valueAddedTaxIndicator": { "type": "string", "description": "Possible values: INC (VAT Included) or EX (VAT Excluded from payment amount). Applicable to RUB payments to Russia" }, "creditorAgentBranchName": { "maxLength": 140, "type": "string", "description": "Branch Name of the Beneficiary Bank (Creditor Agent)", "format": "max 140 characters" }, "creditorAgentInstruction": { "type": "string", "description": "Any Bank-toBank Information (BBI) populated by Originating Bank (Debtor Agent) for Beneficiary Bank (Creditor Agent)." }, "creditorContactPhoneNumber": { "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$", "type": "string", "description": "Contact phone number for the Beneficiary Company (Creditor). Country-specific validations apply" }, "creditorAgentClearingMemberID": { "maxLength": 35, "type": "string", "description": "Clearing Member ID of Beneficiary Bank (Creditor Agent) e.g. USA ABA number, UK Sort Code, etc.", "format": "max 35 characters" }, "instructingReimbursementAgent": { "type": "string", "description": "Instructing Reimbursement Agent to be used for this payment" } } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "callbacks": {} }, "webhooks": {}, "x-tagGroups": [ { "name": "API Reference", "tags": [ "Bank API", "Company API", "Payments API", "Reference Data API" ] } ] } ```