# B2B Virtual Account Payment Method
Flexible and secure payment method for B2B market segments using virtual accounts.

## Version: 1

### Servers

| URL | Description |
| --- | ----------- |
| https://sandbox.api.visa.com | Sandbox server |

---
### Schemas

#### UpdateBuyerRequest Schema

Profile details of the buyer being updated.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for this request. Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } |  | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### CreateBuyerTemplateRequest-4 Schema

Create Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID associated with the bank. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Client-provided name of the template. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | Yes |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | Yes |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Client-defined template description. Supports AlphaNumeric characters. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | Yes |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### CreateBuyerTemplateRequest-3 Schema

Create Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID associated with the bank. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Client-provided name of the template. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | Yes |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | Yes |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Client-defined template description. Supports AlphaNumeric characters. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | Yes |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### ErrorItem Schema

Error Item

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorCode | string |  | No |
| errorDescription | string |  | No |

#### CreateBuyerTemplateRequest-5 Schema

Create Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID associated with the bank. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Client-provided name of the template. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | Yes |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | Yes |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Client-defined template description. Supports AlphaNumeric characters. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | Yes |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### CreateBuyerTemplateRequest-2 Schema

Create Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID associated with the bank. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Client-provided name of the template. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | Yes |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | Yes |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Client-defined template description. Supports AlphaNumeric characters. | No |
| virtualAccountConfig | { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", **"parameterValue"**: string } ] } | Virtual account configuration for a buyer template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | Yes |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### CreateBuyerTemplateRequest-1 Schema

Create Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID associated with the bank. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Client-provided name of the template. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | Yes |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | Yes |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Client-defined template description. Supports AlphaNumeric characters. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | Yes |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### UpdateBillingConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| billingBID | string | The 11 digit Visa Billing BID that will be billed for the service. This is in the format of 8 digit Visa BID plus 3 digit country code. E.g. 12345678840 where 840 is country code for United States. | No |
| billingType | string | Identifies who will be billed for use of the service.  Valid Values are I, T or M.  Select I if the issuer will be billed (standard). Select T if Third party / fintech will be billed. Select M if billing needs to be manually billed (not common). | No |

#### BErrorResponse Schema

Create Buyer Template Error Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorObject | { **"errorList"**: [ { **"errorCode"**: string, **"errorDescription"**: string } ] } | Error object | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### ProcessPaymentErrorResponse Schema

Error Codes

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PP001 | object | Successfully processed. | No |
| PP002 | object | Message ID is not unique. | No |
| PP003 | object | Invalid Client ID. | No |
| PP004 | object | Invalid buyer. | No |
| PP005 | object | Invalid card account number. | No |
| PP006 | object | Invalid payment amount. | No |
| PP007 | object | Invalid payment date. | No |
| PP008 | object | Invalid supplier ID. | No |
| PP009 | object | Invalid currency code. | No |
| PP010 | object | Buyer does not match with the issuer. | No |
| PP011 | object | Account number does not match with the buyer. | No |
| PP012 | object | Invalid primary email address | No |
| PP013 | object | Invalid alternate email address | No |
| PP014 | object | Invalid invoice number | No |
| PP015 | object | Invalid invoice date. | No |
| PP016 | object | Internal error. | No |
| PP019 | object | Failed to set payment control. | No |
| PP020 | object | Payment control validation failed. | No |
| PP021 | object | Payment control validation failed. | No |
| PP022 | object | Card account is currently being used for other transaction. | No |
| PP024 | object | Payment gross amount not equal to sum of invoice amounts. | No |
| PP025 | object | Bank or buyer not subscribed for the service. | No |
| PP027 | object | Request is already processed. | No |
| PP031 | object | Payment control cannot be added as the account already has 10 exact match rules set. | No |
| PP032 | object | Transaction amount should be greater than zero. | No |
| PP035 | object | Invalid message ID. | No |
| PP036 | object | Invalid invoice amount. | No |
| PP037 | object | Invalid supplier name. | No |
| PP038 | object | Invalid supplier city. | No |
| PP039 | object | Invalid supplier state. | No |
| PP040 | object | Invalid supplier country. | No |
| PP041 | object | Invalid supplier postal code. | No |
| PP042 | object | Invalid supplier address line. | No |
| PP046 | object | Payment currency code does not match with buyer’s configured currency code. | No |
| PP047 | object | Invalid action type. | No |
| PP049 | object | Invalid payment expiration date. | No |
| PP050 | object | Supplier ID is required. | No |
| PP051 | object | SupplierID is not associated with any STP supplier. | No |
| PP052 | object | Incorrect supplier and STP ID combination. | No |
| PP053 | object | STP ID does not exist. | No |
| PP055 | object | STP supplier ID not exist. | No |
| PP056 | object | Invalid STP supplier ID. | No |
| PP057 | object | Invoice tag is mandatory. | No |
| PP058 | object | Invalid purchase order number. | No |
| PP059 | object | Invalid purchase order date. | No |
| PP060 | object | Invalid email notes. | No |
| PP061 | object | Invalid reference fields. | No |
| PP062 | object | Account expiry date is not available for the card. | No |
| PP063 | object | Payment expiration date provided is in the past. | No |
| PP064 | object | No single use card accounts available. | No |
| PP065 | object | Invalid card (VRZ card) when processor interaction is disabled. | No |
| PP066 | object | Supplier is inactive for this payment. | No |
| PP067 | object | Corporate available balance validation failed. | No |
| PP068 | object | Corporate available balance for buyer is locked by another process. | No |
| PP069 | object | CyberSource communication error. | No |
| PP075 | object | CyberSource request 200- The authorization request was approved by the issuing bank but declined by CyberSource because it did not pass the Address Verification Service (AVS) check. | No |
| PP076 | object | CyberSource request 201- The issuing bank has questions about the request. You do not receive an authorization code programmatically but you might receive one verbally by calling the processor. | No |
| PP077 | object | CyberSource request 202- Expired card. You might also receive this if the expiration date you provided does not match the date the issuing bank has on file. | No |
| PP078 | object | CyberSource request 203- General decline of the card. No other information provided by the issuing bank. | No |
| PP079 | object | CyberSource request 208- Inactive card or card not authorized for card-not- present transactions. | No |
| PP080 | object | CyberSource request 231- Invalid account number. | No |
| PP081 | object | CyberSource request 232- The card type is not accepted by the payment processor. | No |
| PP082 | object | CyberSource request 233- General decline by the processor. | No |
| PP083 | object | CyberSource request 234- There is a problem with your CyberSource merchant configuration. | No |
| PP084 | object | CyberSource request 236- Processor failure. | No |
| PP085 | object | CyberSource request 238- CyberSource request 101- The authorization has already been captured. | No |
| PP086 | object | CyberSource request 240- The card type sent is invalid or does not correlate with the credit card number. | No |
| PP087 | object | CyberSource request 250- The request was received but there was a timeout at the payment processor. | No |
| PP088 | object | Processor interaction failed. | No |
| PP096 | object | Account for STP payment should not have VPC enabled. | No |
| PP097 | object | Payment control interaction failed. | No |
| PP098 | object | Account currency code does not match with payment currency code. | No |
| PP163 | object | Primary email address is required if supplier enabled for notification. | No |
| PP170 | object | Invalid payment description. | No |
| PP171 | object | Invalid payment date. | No |
| PP174 | object | Bank and buyer product type is not matching. | No |
| PP175 | object | Problem while setting the gross amount rule in VPC. | No |
| PP176 | object | Account is registered in VPC but not enabled for VPC. | No |
| PP177 | object | Supplier should be of type STP to process STP payments. | No |
| PP178 | object | Payment requisition is disabled. | No |
| PP179 | object | Account is deleted. | No |
| PP181 | object | Invalid reference tag. | No |
| PP182 | object | Invalid alternate address tag. | No |
| PP183 | object | Failure to remove payment control. | No |
| PP184 | object | Either bank or buyer is not having STP participation enabled. | No |
| PP185 | object | No card account available in pool. | No |
| PP186 | object | The account type sent in the web service request is invalid. | No |
| PP561 | object | The month you have entered for the card expiry date is invalid. Please enter a valid month. | No |
| PP562 | object | The card expiry date you have entered is in the past. Please enter a future date. | No |
| PP563 | object | The year you have entered for the card expiry date is invalid. Please enter a valid year. | No |
| PP564 | object | Account number field is mandatory when expiration date is provided. | No |
| PP565 | object | The card expiry date sent in the request is invalid. Please correct and re-submit. | No |
| PP566 | object | Card expiration date field is mandatory for a new card account in the request. | No |
| PP567 | object | Payment Requisition requires a valid proxy account number. | No |
| PP568 | object | The account type sent in the web service request is invalid. | No |
| PP569 | object | Account type is not applicable for SUA payments. | No |
| PP576 | object | The Account Limit field is mandatory for lodged card payments. | No |
| PP577 | object | The Account Limit sent in the request is greater than the maximum allowed limit Max allowed limit. | No |
| PP582 | object | SupplierName is mandatory. | No |
| PP586 | object | The Account Limit field should be numeric. | No |
| PP587 | object | Account Limit cannot have precision value. | No |
| PP589 | object | The Process Payment web service supports only max number allowed invoices | No |
| PP590 | object | Payment cannot be processed for a Closed Account | No |
| PP591 | object | The currency sent in the payment instruction does not match with the allowed currencies for the buyer. Please work with your administrator to add the new currency in the allowable list before submitting a payment. | No |
| PP594 | object | The value you sent in the AccountNumber field is invalid. Please pass a valid pseudo account, and proxy number of the funding account associated with your buyer. | No |
| PP595 | object | Error occurred while generating a new pseudo account. Please try your request later. | No |
| PP596 | object | The value you sent for the funding account field is not uniquely identifying the funding account. Please send the entire 16 digit funding account number. | No |
| PP069a | object | CyberSource request 101- The request is missing one or more required fields. | No |
| PP069b | object | CyberSource request 102- One or more fields in the request contain invalid data. | No |
| PP069c | object | CyberSource request 150- Error- General system failure. | No |
| PP069d | object | CyberSource request 151- The request was received but there was a server timeout. This error does not include timeouts between the client and the server. | No |
| PP069e | object | CyberSource request 152- The request was received, but a service did not finish running in time. | No |
| PP088a | object | Processor interaction failed. | No |
| PP088b | object | Processor interaction failed. | No |
| PP088c | object | Processor interaction failed. | No |
| PP088d | object | Processor interaction failed. | No |
| PP088e | object | Processor interaction failed. | No |
| PP088f | object | Processor interaction failed. | No |
| PP088g | object | Processor interaction failed. | No |
| PP567a | object | The account type passed in the web service request is different from what is setup in the VPA system. | No |
| PP5967 | object | The default payment currency of the lodged pseudo account you have sent in the request is different from the payment currency. Please pass the correct pseudo account. | No |

#### UpdateWebServicesConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] |  | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric.  Can be set at any time if it is blank.  But cannot be changed if it is already set if the sync Buyer Profiles field is set to true. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the template (Buyer).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. Can be enabled (set to true) at any time.  But cannot be disabled if sync Buyer Profiles field is set to true. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. Valid Values are 'True' or 'False'. This field can be edited at any time. | No |

#### ReconciliationFileConfigForCreate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the recon file outbound. Required if the file level is B. The Visa implementation team provides this value after the outbound recon file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| deliveryTime | string | Denotes the delivery type or day when the recon file needs to be generated and delivered. If the value for this field (the tag is not sent) is not provided, the system defaults it to'1:00' AM for the daily frequency and 2 for weekly and 1 for monthly frequency.   Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| templateName | string | Denotes the name of the recon template to be used for generating the reconciliation file. If the value for this field (the tag is not sent) is not provided, the system defaults it to the latest recon standard template. | No |
| deliveryFrequency | integer | Denotes the frequency in which the recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the recon file in their VOL mailbox. You can setup upto 80 user ids to receive the recon file. The user ids should have the VOL mailbox service entitled to them. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the buyer. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Adhoc Reconciliation. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the buyers.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Reconciliation. | No |

#### VanConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank FCS ID if there is only one setup at the bank level. Supports alphanumeric values. Required if the buyer is enabled for VANs. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| aceClientId | string | Denotes the  number used to identify the bank on the Tsys ACE Decision Max system for account assignment.<br>**Read-only** | No |
| admClientId | string | Denotes the number the TSYS VPP system uses to identify the company on the ACE Decision Max system for account assignment. | No |
| mcADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. This field will be populated only if it is a Mastercard Bank. | No |
| processingType | string | Denotes the Processing type for the virtual account number (VAN). | No |
| visaADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. This field will be populated only if it is a Visa Bank. | No |
| settlementExpirationDays | integer | Denotes the number of days after which settlement will not be honored on the virtual account (VAN).<br>**Read-only** | No |

#### UpdateRVAReconciliationFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Comm file Id refers to Comm File info associated with the Request Virtua Account recon file outbound delivery. Required if RVAReconFileDelivery is set to Comms.  This field Can be edited at any time. | No |
| templateId | string | Denotes the template identifier associated with the RVA recon template to be used for generating the RVA recon file. This field Can be edited at any time. | No |

#### GetPaymentSecurityConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customSecurityQuestions | [ string ] | The questions (text) which will be used at random (Only one of the questions will be displayed) to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. The system sends the security questions and answers to the supplier when the supplier is setup for the buyer.  At least one question needs to be sent if custom security question is enabled for the template. | No |
| defaultSecurityQuestion | string | Denotes the text for the default security question which will be displayed to the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. | No |
| defaultSecurityFieldCode | string | Denotes the field system uses to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. | No |
| customSecurityQuestionsEnabled | boolean | Denotes if the buyer wants to use custom security questions to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. | No |

#### ProxyConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| holdDays | string | Denotes the number of days an account picked up for a payment in a proxy will be kept on hold before being used for another payment.  For payments, the hold days start from the day the payment was processed and for Request Virtual Account, the hold days start from the day the end date of the RVA has reached. Should be a numeric value between 1 to 999. If the value for this field (the tag is not sent) is not provided, the system defaults it to 90 days. | No |
| autoRefreshEnabled | boolean | Denotes if auto replenishment is enabled for proxies associated with the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False for memo account buyers and to true for VIP and VPP enabled buyers.   The value of this field should be set to true for VIP and VPP enabled buyers.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for auto replenishment. | No |
| bucketedProxyEnabled | boolean | Denotes if bucketed proxy is enabled for proxies associated with the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for bucketed proxy. | No |

#### StpPaymentConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stpPaymentEnabled | boolean | Denotes if STP payments is enabled for the buyer.  Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'. Valid values are 'True' or 'False'. This field can be set to true only if the bank STP Payment option is set to  'True'. | No |
| accountHolderLastName | string | Denotes the Account Holder Last Name which will be used while processing the STP payment. If the value for this field (the tag is not sent) is not provided, system defaults to the buyer primary contact person's name (The value from the first space character until the end of the field will be used as the last name). | No |
| accountHolderFirstName | string | Denotes the Account Holder First Name which will be used while processing the STP payment. If the value for this field (the tag is not sent) is not provided, system defaults to the buyer primary contact person's name (The value upto the first space character will be used as the first name) | No |
| remittanceNotificationEnabled | boolean | Denotes if the STP Payment Remittance notification is enabled for a buyer.  Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'. Valid values are 'True' or 'False'. This field can be set to true only if the bank STP Payment Remittance Notification option is set to 'True'. The STP supplier will be getting the payment remittance notification only if this field is enabled. | No |

#### VirtualAccountConfigForCreate Schema

Virtual account configuration supplied when creating a buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| virtualAccountType | string | Virtual account type for the buyer. Valid values are '1' (processor PANs), '2' (VIP token), '3' (VPP token) and '4' (visa-virtual-card). No other value is accepted. | Yes |
| additionalParameters | [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId", **"parameterValue"**: string } ] | Additional parameters for the virtual account configuration. Required for virtualAccountType '3' (VPP): 'fcsBankId', 'admClientId' and 'processingType' are always required, and at least one of 'visaADMOptionId' or 'mcADMOptionId' is also required. Not required for virtualAccountType '2' (VIP) or '4' (visa-virtual-card). | No |

#### ContactInfoForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | Contains the City Name of the buyer's contact address. | Yes |
| state | string | Contains the state of the buyer's contact address. | No |
| phone1 | string | Contains the buyer contact phone number 1. Field is alphanuemeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone2 | string | Contains the buyer contact phone number 2. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone3 | string | Contains the buyer contact phone number 3. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| buyerId | string | Contains the buyer identifier as defined in Visa Payables Automation. This is often the ID defined at the processor. Value format is 0–9. It is a mandatory field. | No |
| zipCode | string | Optional. Contains the Postal Code of the buyer's contact address.  Do not include special characters, e.g. hyphen, in the zipcode.  If a special character is provided it will be removed and processed with only nine digits. Null is allowed. | Yes |
| buyerName | string | Contains the name of the buyer.  It is a mandatory field. | Yes |
| companyId | string | Contains the buyer identifier as defined at the issuer processor. Value format is 0–9. It is a mandatory field. | Yes |
| phone1Ext | string | Contains the extension of the buyer contact phone number 1. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone2Ext | string | Contains the extension of the buyer contact phone number 2. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone3Ext | string | Contains the extension of the buyer contact phone number 3. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| templateId | string | Contains the unique identifier for a Template asscoiated with the bank. Template id of the template which was sent in the response when you created a new template.  This field should be blank if the buyer is created without a template. | No |
| contactName | string | Contains the name of the primary contact person in the buyer. The input should be alphabets. | Yes |
| countryCode | string | Contains the ISO alpha country code of the buyer's contact address. For example- USA. | Yes |
| addressLine1 | string | Contains the line 1 of the buyer's contact address. | Yes |
| addressLine2 | string | Contains the line 2 of the buyer's contact address. | No |
| addressLine3 | string | Contains the line 3 of the buyer's contact address. | No |
| emailAddress | string | Contains the buyer's contact Email Address.  Should be an valid email address. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.  Select 1 if buyer will use VPA user interface  (issuer direct use of VPA).  Select 2 if buyer is created by a third party fintech and will use the VPA APIs.  Select 3 if buyer is created in VPA for Visa Commercial Pay service. | No |

#### BuyerFeatureConfigForGetV2-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| vcfDataFeedIndicator | string | Denotes if the financial institution will be providing buyer/business(VCF) data for the buyer. Valid Values are 'Y' and 'N'. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer. | No |

#### ContactInfoForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | Contains the City Name of the buyer's contact address. | No |
| state | string | Contains the state of the buyer's contact address. | No |
| phone1 | string | Contains the buyer contact phone number 1. | No |
| phone2 | string | Contains the buyer contact phone number 2. | No |
| phone3 | string | Contains the buyer contact phone number 3. | No |
| buyerId | string | Contains the buyer identifier as defined in Visa Payables Automation. This is often the ID defined at the processor. | No |
| zipCode | string | Contains the Postal Code of the buyer's contact address. | No |
| buyerName | string | Contains the name of the buyer. | No |
| companyId | string | Contains the company identifier as defined at the issuer processor. | No |
| phone1Ext | string | Contains the extension of the buyer contact phone number 1. | No |
| phone2Ext | string | Contains the extension of the buyer contact phone number 2. | No |
| phone3Ext | string | Contains the extension of the buyer contact phone number 3. | No |
| templateId | string | Contains the unique identifier for a Template asscoiated with the bank. | No |
| contactName | string | Contains the name of the primary contact person in the buyer | No |
| countryCode | string | Contains the ISO alpha country code of the buyer's contact address. For example- USA. | No |
| addressLine1 | string | Contains the line 1 of the buyer's contact address. | No |
| addressLine2 | string | Contains the line 2 of the buyer's contact address. | No |
| addressLine3 | string | Contains the line 3 of the buyer's contact address. | No |
| emailAddress | string | Contains the buyer's contact Email Address. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.  1 denotes buyer uses VPA UI (issuer direct use of VPA).  2 denotes buyer using a third party fintech user interface and third party is using VPA APIs.  3 denotes buyer uses Visa Commercial Pay service. | No |

#### WebServicesConfigForGetV2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Denotes the codes associated with APIs which needs to be enabled for the buyer.  The APIs should be a subset of what is enabled for the bank.  The API codes and the corresponding APIs can be found below .... | No |
| clientId | string | Denotes the client id associated with the bank under which the buyer is being created.  The Visa implementation team will be providing this. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer. Valid Values are 'True' and 'False'. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. Valid Values are 'True' or 'False'. | No |

#### ResponseFileConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the response COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B and C. | No |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. Required if the file level is B. The Visa implementation team provides this value after the outbound response file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the response file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the response file in their VOL mailbox.  You can setup upto 50 user ids to receive the response file. The user ids should have the VOL mailbox service entitled to them. | No |

#### UpdateSTPPaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stpPaymentEnabled | boolean | Denotes if the STP Payments is enabled for a template (buyer).Optional field.  Valid values are 'True' or 'False'. This field can be set to true only if the bank STP Payments option is set to  'True'.  This field can be enabled (set to true) at any time but cannot be disabled if the sync Buyer Profiles is set to true. | No |
| remittanceNotificationEnabled | boolean | Denotes if the STP Payment Remittance notification is enabled for a template (buyer).  Valid values are 'True' or 'False'. This field can be set to true only if the bank STP Payment Remittance Notification option is set to 'True'. Only if this field is enabled, the STP supplier will be getting the payment remittance notification. This field can be edited at any time. | No |

#### ResponseFileConfigForGet-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the response COMM File configuration is defined to be delivered to the bank(B) or Company (C). | No |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. The Visa implementation team provides this value after the outbound response file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the response file needs to be generated. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the response file in their VOL mailbox. | No |

#### AuthorizationControlConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertsEnabled | boolean | Denotes if the system needs to send an alert when an authorization on a VPC enabled card is approved or declined.  Valid values are 'True' and 'False'. This field can be set to True only if the authControlEnabled is set to true for the template. | No |
| issuerHoldingBID | string | Denotes the Holding BID (business id) for the issuer.  Should be numeric. Should be set only if authControlEnabled is set to true for the template. | No |
| authControlEnabled | boolean | Denotes if the authorization controls needs to be enabled for the template (in turn the buyer).  Auth controls is mandated for VPP and VIP buyers.  If the value for this field (the tag is not sent) is not provided, the system defaults it to True if mandate auth controls is set to 'True' for the bank otherwise the system defaults it to False. | No |

#### OptionalInfo Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| optionalFieldName | string | Name of the optional field<br>*Example:* `"invoiceNumber"` | No |
| optionalFieldValue | string | Value of the optional field<br>*Example:* `"INV-2024-001"` | No |

#### UpdateBoostPaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| boostPaymentEnabled | boolean | Denotes if the Boost Payments is enabled for a template (buyer).Optional field.  Valid values are 'True' or 'False'. This field can be set to true only if the bank Boost Payments option is set to  'True'.  This field can be enabled (set to true) at any time but cannot be disabled if the sync Buyer Profiles is set to true. | No |

#### GetBuyerSuccessResponseV2-1 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### BuyerFeatureConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12.  This field can be updated at any time. | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be enabled (set to true) but can not be disabled (set to false). If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this functionality. This field can be updated at any time. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12.  This field can be updated at any time. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer. Valid Values are 'True' and 'False'.  The value can be set to true only if the bank is enabled for Online Payment Instructions.  This field can be updated at any time. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Requisitions. This field can be updated at any time. | No |

#### GetReconciliationFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Comm file Id refers to Comm File info associated with the recon file outbound delivery.Required if ReconFileDelivery is set to Comms. | No |
| templateName | string | Denotes the name of the custom Reconciliation template to be used for generating the reconciliation file for all buyers using the template. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the template (buyers). | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the template (buyers). | No |

#### GetBuyerSuccessResponse Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### VanConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  This value will be provided by the Visa implementation team. If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank FCS ID if there is only one setup at the bank level. Supports alphanumeric values. Required if the buyer is enabled for VANs. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| admClientId | string | Denotes the number the TSYS VPP system uses to identify the company on the ACE Decision Max system for account assignment. This value will be provided by the Visa implementation team. | No |
| mcADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. This value will be provided by the Visa implementation team.  If it is a Mastercard  bank, then this field is required. | No |
| processingType | string | Denotes the Processing type for the virtual account number (VAN). This value will be provided by the Visa implementation team. | No |
| visaADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. If it is a Visa bank, then this field is required. This value will be provided by the Visa implementation team. | No |

#### BuyerFeatureConfigForGetV2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| vcfDataFeedIndicator | string | The vcfDataFeedIndicator is used for indicating the source of transactions/settlement data for this company. This value should be “Yes” if the FI/Processor is going to send settled transactions for the company [e.g. inbound Visa Commercial Format (VCF)]. It should be “No” if the company requires Visa to pull the settlement data over the Visa Network.   | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer. If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer. | No |

#### GetBuyerSuccessResponseV2-2 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### RvaReconciliationFileConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the RVA recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the RVA recon file outbound. Required if the file level is B. The Visa implementation team provides this value after the outbound RVA recon file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the RVA recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| templateId | string | Denotes the id of the recon template to be used for generating the RVA reconciliation file. The template id is returned in the response when you create a new template.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the latest RVA recon standard template (currentyly 1).  Valid values are 1 - RVA Recon standard template Version 1.0 | No |
| deliveryTime | string | Denotes the delivery type or day when the RVA recon file needs to be generated and delivered. If the value for this field (the tag is not sent) is not provided, the system defaults it to'1:00' AM for the daily frequency and 1 for weekly and monthly frequency.   Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| deliveryFrequency | integer | Denotes the frequency in which the RVA recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the RVA recon file in their VOL mailbox. You can setup upto 50 user ids to receive the RVA recon file.The user ids should have the VOL mailbox service entitled to them. | No |

#### GetBuyerSuccessResponseV2-3 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### GetBuyerSuccessResponseV2-4 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"virtualAccountConfig"**: [ { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId", **"parameterValue"**: string } ] } ], **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### ApprovalWorkflowConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| workflowConfigEnabled | boolean | Denotes if the Approval Workflow is enabled for the Buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| workflowFunctionCodes | [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] | Denotes the codes for the functionalities for which Approval Workflow needs to be enabled. Valid Values are AUCL - Card Limit Update, LCRC - Lodge/New Card, PYIN - Payment Instruction, PYRN - Payment Requisition At least one function should be passed in this field if workflowconfigenabled field is set to true for the buyer. | No |

#### GetBuyerTemplateResponse Schema

Get Buyer Template Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### GetBuyerTemplateResponseV2-2 Schema

Get Buyer Template Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### ProcessorConfigForGet Schema

This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| embossedLine2 | string | Denotes the default embossedLine2 for cards.  This usually is the buyer name prefixed by a running number for FIS and buyer name followed by a running number for other processors<br>**Read-only** | No |
| processorFields | object |  | No |
| suaEmbossedLine1 | string | Denotes the default embossedLine1 for SUA cards.  This usually is the buyer name prefixed by a running number for FIS and buyer name followed by a running number for other processors<br>**Read-only** | No |
| closeAccountEnabled | boolean | Default to Yes if processor integration is enabled for the bank. Default to N if Processor integration is not enabled for the bank. Default to Y if the buyer is enabled for VIP/VPP tokens. | No |
| lodgedEmbossedLine1 | string | Denotes the default embossedLine1 for lodged cards.  This usually is the Supplier name prefixed by a running number for FIS and Supplier name followed by a running number for other processors<br>**Read-only** | No |

#### GetBuyerTemplateResponseV2-1 Schema

Get Buyer Template Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### GetBuyerTemplateResponseV2-4 Schema

Get Buyer Template Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### BError Schema

Error object

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorList | [ { **"errorCode"**: string, **"errorDescription"**: string } ] |  | No |

#### CancelPaymentRequest Schema

Cancel payment request payload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| buyerId | string | Buyer ID is the buyer identifier as defined in Visa Payables Automation. Value format is 09. | Yes |
| issuerId | string | A '-' (hyphen) separated field which contains the region id, processor id and bank id | Yes |
| vendorId | string | Identifier used by the buyer to identify the vendor. This is the vendor id of the vendor whose payment is being canceled. | Yes |
| clientKey | string | Client key for secure communication | No |
| messageId | string | Unique ID specific to this API call. | Yes |
| cancelReason | string | Contains the reason for canceling the payment. | No |
| accountNumber | string | An existing Visa card account. Values are  09. Note- If the account number is passed, it should correspond to the card account number used for the payment. | No |
| codeChallenge | string | Code Challenge for secure communication | No |
| accountingSoftwareEntityId | string | Unique ID used by that particular accounting software entity<br>*Example:* `"bill Id with respect to QuickBooks Online(QBO)"` | Yes |

#### BillingConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| billingBID | string | The 11 digit Visa Billing BID that will be billed for the service. This is in the format of 8 digit Visa BID plus 3 digit country code. E.g. 12345678840 where 840 is country code for United States. | No |
| billingType | string | Identifies who will be billed for use of the service.  I indicates issuer will be billed (standard). T indicates Third party / fintech will be billed. M indicates manual billing is set up. | No |

#### GetBuyerTemplateResponse-3 Schema

Get Buyer Template Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### AlternateEmailAddress Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alternateEmailAddress | string |  | No |

#### GetBuyerTemplateResponse-2 Schema

Get Buyer Template Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### ResponseFileConfigForCreate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the response COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B and C. | No |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. Required if the file level is B. The Visa implementation team provides this value after the outbound response file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the response file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the response file in their VOL mailbox.  You can setup upto 80 user ids to receive the response file. The user ids should have the VOL mailbox service entitled to them. | No |

#### GetBuyerTemplateResponse-1 Schema

Get Buyer Template Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### CreateBuyerTemplateResponse Schema

Create Buyer Template Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the CreateTemplate API. | Yes |

#### ProxyConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| holdDays | string | Denotes the number of days an account picked up for a payment in a proxy will be kept on hold before being used for another payment.  For payments, the hold days start from the day the payment was processed and for Request Virtual Account, the hold days start from the day the end date of the RVA has reached. | No |
| autoRefreshEnabled | boolean | Denotes if auto replenishment is enabled for proxies associated with the buyer. | No |
| bucketedProxyEnabled | boolean | Denotes if bucketed proxy is enabled for proxies associated with the buyer.  Valid Values are 'True' and 'False'. | No |

#### GetBuyerSuccessResponse-1 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### GetBuyerSuccessResponse-2 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### GetBuyerSuccessResponse-3 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### PaymentFileCommConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| edi824FileId | string | Denotes the Comm File ID associated with the EDI 824 outbound response file.  The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound edi 824 file configuration has been completed. This field can be updated at anytime. | No |
| edi997FileId | string | Denotes the Comm File ID associated with the EDI 997 outbound ack file. The COMM file definition should exist in the system.  The Visa implementation team provides this value after the the outbound edi 997 file configuration has been completed. This field can be updated at anytime. | No |
| inboundFileId | string | Denotes the Comm file ID associated with the inbound payment file (EDI 820 or SFF). The COMM file definition should exist in the system.  The Visa implementation team provides this value after the inbound file configuration has been completed.  This field can be updated at anytime | No |

#### GetBuyerTemplateSuccessResponse-3 Schema

Get Buyer Template Success Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### GetBuyerTemplateSuccessResponse-2 Schema

Get Buyer Template Success Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### GetBuyerTemplateSuccessResponse-1 Schema

Get Buyer Template Success Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### BuyerFeatureConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12 | No |
| vcfDataFeedIndicator | string | The vcfDataFeedIndicator is used for indicating the source of transactions/settlement data for this company. This value should be “Yes” if the FI/Processor is going to send settled transactions for the company [e.g. inbound Visa Commercial Format (VCF)]. It should be “No” if the company requires Visa to pull the settlement data over the Visa Network.   | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers). Valid Values are 'True' and 'False'.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   The value can be set to true only if the bank is enabled for this Option. If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank setting for this field.   The value can be set to true only if the bank is enabled for this functionality. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12 | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.     The value can be set to true only if the bank is enabled for Online Payment Instructions. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   The value can be set to true only if the bank is enabled for Online Payment Requisitions. | No |

#### UpdateStripePaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stripePaymentEnabled | boolean | Denotes if Stripe payments is enabled for the template (buyer).  Optional field.  Valid values are 'True' or 'False'. This field can be set to true only if the bank Stripe Payment option is set to  'True'. This field can be enabled (set to true) at any time but cannot be disabled if the sync Buyer Profiles is set to true. | No |
| remittanceNotificationEnabled | boolean | Denotes if the Stripe Payment Remittance notification is enabled for a template (buyer).  Valid values are 'True' or 'False'. This field can be set to true only if the bank Stripe Payment Remittance Notification option is set to 'True'. Only if this field is enabled, the Stripe supplier will be getting the payment remittance notification. This field can be edited at any time. | No |

#### WebServicesConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Reserved for Future use. The system will default the apiCodes to what is set for the bank. | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system.  Field is alphanumeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves.   If the value for this field (the tag is not sent) is not provided, the system defaults it to False. Valid Values are 'True' or 'False'. | No |

#### BatchRequisitionRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string, <br>**Available values:** "A" | Action type - 'A' for Add/Create bulk requisition<br>*Enum:* `"A"`<br>*Example:* `"A"` | Yes |
| buyerID | string | Unique identifier for the buyer<br>*Example:* `"67890"` | Yes |
| clientID | string | Unique identifier for the client<br>*Example:* `"12345"` | Yes |
| messageID | string | Unique message identifier for tracking<br>*Example:* `"MSG-2024-001"` | Yes |
| proxyPoolID | string | Proxy pool identifier (optional)<br>*Example:* `"POOL-001"` | No |
| optionalInfo | [ { **"optionalFieldName"**: string, **"optionalFieldValue"**: string } ] | Array of optional field name-value pairs | No |
| numberOfCards | string | Number of virtual accounts to create<br>*Example:* `"100"` | Yes |
| requisitionDetails | { **"rules"**: [ { **"ruleCode"**: string, **"overrides"**: [ { **"sequence"**: string, **"overrideCode"**: string, **"overrideValue"**: string } ] } ], **"endDate"**: string, **"timeZone"**: string, **"startDate"**: string, **"mcgRuleAction"**: string } |  | No |

#### Rules Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ruleCode | string | Code identifying the rule type<br>*Example:* `"MERCHANT_CATEGORY"` | No |
| overrides | [ { **"sequence"**: string, **"overrideCode"**: string, **"overrideValue"**: string } ] | Array of override values for this rule | No |

#### ErrorResponse Schema

Create Buyer Template Error Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorObject | { **"errorList"**: [ { **"errorCode"**: string, **"errorDescription"**: string } ] } | Error object | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### BatchRequisitionResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageID | string | Message identifier echoed from the request<br>*Example:* `"MSG-2024-001"` | No |
| responses | [ { **"responseCode"**: string, **"responseDescription"**: string } ] | Array of response codes and descriptions | No |
| bulkReferenceId | string | Bulk reference ID for tracking this batch requisition<br>*Example:* `"BRK-20241124-001"` | No |

#### WebServicesConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] |  | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system.  Should be alphanumeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the template (Buyer).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it false.   The value can be set to true only if the bank is enabled for this Option. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed. Valid Values are 'True' or 'False'. If this field is set to true, then the web service consumers should handle the supplier communication themselves.   If the value for this field (the tag is not sent) is not provided, the system defaults it to False. | No |

#### POPErrorResponse Schema

Error Response for POP APIs

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique ID specific to this API call. | Yes |
| statusCode | integer | HTTP Error status code | Yes |
| errorResponse | { **"errorItems"**: [ { **"errorCode"**: string, **"errorDescription"**: string } ] } | Error Response Schema | Yes |
| statusDescription | string | HTTP Error status description | No |

#### UpdateWebServicesConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] |  | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system.  Should be alphanumeric.  Can be set at any time if it is blank.  But cannot be changed if it is already set if the sync Buyer Profiles field is set to true. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the template (Buyer).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. Can be enabled (set to true) at any time.  But cannot be disabled if sync Buyer Profiles field is set to true. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. Valid Values are 'True' or 'False'. This field can be edited at any time. | No |

#### UpdateReconciliationFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Adhoc Reconciliation.  This field Can be edited at any time. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Reconciliation.  This field Can be edited at any time. | No |

#### ResponseFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. | No |

#### UpdateVanConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  Supports alphanumeric values. Required if the template is enabled for VANs. Can be set at any time if it is blank.  But cannot be changed if it is already set if the sync Buyer Profiles field is set to true. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  Can be set to true any time.  But cannot be disabled if the sync Buyer Profiles field is set to true. | No |

#### PaymentFileCommConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| edi824FileId | string | Denotes the Comm File ID associated with the EDI 824 outbound response file. | No |
| edi997FileId | string | Denotes the Comm File ID associated with the EDI 997 outbound ack file. | No |
| inboundFileId | string | Denotes the Comm file ID associated with the inbound payment file (EDI 820 or SFF). | No |

#### UpdateResponseFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. This field Can be edited at any time. | No |

#### ResponseFileConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the response COMM File configuration is defined to be delivered to the bank(B) or Company (C). | No |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. The Visa implementation team provides this value after the outbound response file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the response file needs to be generated. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the response file in their VOL mailbox. | No |

#### ApprovalWorkflowConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| workflowConfigEnabled | boolean | Denotes if the Approval Workflow is enabled for the Buyer.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. This field can be updated to true at any time.  But cannot be updated to false. | No |
| workflowFunctionCodes | [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] | Denotes the codes for the functionalities for which Approval Workflow needs to be enabled. Valid Values are AUCL - Card Limit Update, LCRC - Lodge/New Card, PYIN - Payment Instruction, PYRN - Payment Requisition At least one function should be passed in this field if workflowconfigenabled field is set to true for the buyer.  This field can be updated at any time. | No |

#### POPErrorResponse-1 Schema

Error Response for POP APIs

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique ID specific to this API call. | Yes |
| statusCode | integer | HTTP Error status code | Yes |
| errorResponse | { **"errorItems"**: [ { **"errorCode"**: string, **"errorDescription"**: string } ] } | Error Response Schema | Yes |
| statusDescription | string | HTTP Error status description | No |

#### VirtualAccountConfigTemplateRequest Schema

Virtual account configuration for a buyer template.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| virtualAccountType | string | Virtual account type for the buyer template. Valid values are '1' (processor PANs), '2' (VIP token), '3' (VPP token) and '4' (visa-virtual-card). No other value is accepted. | Yes |
| additionalParameters | [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", **"parameterValue"**: string } ] | Additional parameters for the virtual account configuration. Only 'fcsBankId' is persisted at the template level for VPP (virtualAccountType '3') — any other key is rejected (error VVC012). 'admClientId', 'processingType', 'visaADMOptionId' and 'mcADMOptionId' are buyer-only fields, set on the Create/Update Buyer request instead. | No |

#### AuthorizationControlConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertsEnabled | boolean | Denotes if the system needs to send an alert when an authorization on a VPC enabled card is approved or declined.  Valid values are 'True' and 'False'. This field can be set to True only if the authControlEnabled is set to true for the buyer. | No |
| issuerHoldingBID | string | Denotes the Holding BID (business id) for the issuer.  Should be numeric. Should be set only if authControlEnabled is set to true for the buyer. | No |
| authControlEnabled | boolean | Denotes if the authorization controls needs to be enabled for the buyer.  Auth controls is mandated for VPP and VIP buyers.  If the value for this field (the tag is not sent) is not provided, the system defaults it to True if mandate auth controls is set to 'True' for the bank otherwise the system defaults it to False. | No |

#### StpPaymentConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stpPaymentEnabled | boolean | Denotes if STP payments is enabled for the buyer.  Valid values are 'True' or 'False'. | No |
| accountHolderLastName | string | Denotes the Account Holder's last Name which will be used while processing the STP payment. | No |
| accountHolderFirstName | string | Denotes the Account Holder's first Name which will be used while processing the STP payment. | No |
| remittanceNotificationEnabled | boolean | Denotes if the STP Payment Remittance notification is enabled for a buyer.  Optional field. Valid values are 'True' or 'False'. The STP supplier will be getting the payment remittance notification only if this field is enabled. | No |

#### StripePaymentConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stripePaymentEnabled | boolean | Denotes if Stripe payments is enabled for the buyer.  Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'. Valid values are 'True' or 'False'. This field can be set to true only if the bank Stripe Payment option is set to  'True'. | No |
| remittanceNotificationEnabled | boolean | Denotes if the Stripe Payment Remittance notification is enabled for a buyer.  Optional field. If the value for this field (the tag is not present) is not provided, the system defaults it to 'False'. Valid values are 'True' or 'False'. This field can be set to true only if the bank Stripe Payment Remittance Notification option is set to 'True'. The Stripe supplier will be getting the payment remittance notification only if this field is enabled. | No |

#### BillingConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| billingBID | string | The 11 digit Visa Billing BID that will be billed for the service. This is in the format of 8 digit Visa BID plus 3 digit country code. E.g. 12345678840 where 840 is country code for United States. | No |
| billingType | string | Identifies who will be billed for use of the service.  I indicates issuer will be billed (standard). T indicates Third party / fintech will be billed. M indicates manual billing is set up. | No |

#### ApprovalWorkflowConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| workflowConfigEnabled | boolean | Denotes if the Approval Workflow is enabled for the Buyer. | No |
| workflowFunctionCodes | [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] | Denotes the codes for the functionalities for which Approval Workflow needs to be enabled. Valid Values are AUCL - Card Limit Update, LCRC - Lodge/New Card, PYIN - Payment Instruction, PYRN - Payment Requisition | No |

#### OnboardingResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientKey | string | Client key for secure communication | No |
| messageId | string | Unique identifier for the message | No |
| errorMessage | string | Error message, if any | No |
| codeChallenge | string | Code Challenge for secure communication | No |

#### CreateBuyerRequest-1 Schema

Buyer Profile Details for creating a new buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } |  | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### CreateBuyerRequest-2 Schema

Buyer Profile Details for creating a new buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } |  | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### CreateBuyerRequest-3 Schema

Buyer Profile Details for creating a new buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| virtualAccountConfig | [ { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId", **"parameterValue"**: string } ] } ] | Virtual account configuration for the buyer. Although this field is an array, only a single configuration is supported per buyer. If more than one entry is sent, only the first entry is considered and the remaining entries are ignored. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### ContactInfoForCreate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | Contains the City Name of the buyer's contact address. | Yes |
| state | string | Contains the state of the buyer's contact address. | Yes |
| phone1 | string | Contains the buyer contact phone number 1. Field is alphanuemeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone2 | string | Contains the buyer contact phone number 2. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone3 | string | Contains the buyer contact phone number 3. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| buyerId | string | Contains the buyer identifier as defined in Visa Payables Automation. This is often the ID defined at the processor. Value format is 0–9. It is a mandatory field. | No |
| zipCode | string | Contains the Postal Code of the buyer's contact address.  Do not include special characters, e.g. hyphen, in the zipcode.  If a special character is provided it will be removed and processed with only nine digits. Null is allowed. | Yes |
| buyerName | string | Contains the name of the buyer.  It is a mandatory field. | Yes |
| companyId | string | Contains the buyer identifier as defined at the issuer processor. Value format is 0–9. It is a mandatory field. | Yes |
| phone1Ext | string | Contains the extension of the buyer contact phone number 1. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone2Ext | string | Contains the extension of the buyer contact phone number 2. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| phone3Ext | string | Contains the extension of the buyer contact phone number 3. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| templateId | string | Contains the unique identifier for a Template asscoiated with the bank. Template id of the template which was sent in the response when you created a new template.  This field should be blank if the buyer is created without a template. | No |
| contactName | string | Contains the name of the primary contact person in the buyer. The input should be alphabets. | Yes |
| countryCode | string | Contains the ISO alpha country code of the buyer's contact address. For example- USA. | Yes |
| addressLine1 | string | Contains the line 1 of the buyer's contact address. | Yes |
| addressLine2 | string | Contains the line 2 of the buyer's contact address. | No |
| addressLine3 | string | Contains the line 3 of the buyer's contact address. | No |
| emailAddress | string | Denotes the buyer's contact email address and must be provided in a valid email format <br><br> Note: This field is required unless a templateId is supplied in the request for a Buyer Template that already contains a predefined emailAddress value. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.  Select 1 if buyer will use VPA user interface  (issuer direct use of VPA).  Select 2 if buyer is created by a third party fintech and will use the VPA APIs.  Select 3 if buyer is created in VPA for Visa Commercial Pay service. | No |

#### CreateBuyerRequest-4 Schema

Buyer Profile Details for creating a new buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } |  | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### VirtualAccountConfigForGet Schema

Virtual account configuration returned for a buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| virtualAccountType | string | Virtual account type for the buyer. Valid values are '1' (processor PANs), '2' (VIP token), '3' (VPP token) and '4' (visa-virtual-card). No other value is returned. | No |
| additionalParameters | [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId", **"parameterValue"**: string } ] | Additional parameters for the virtual account configuration. Present for virtualAccountType '3' (VPP): 'fcsBankId', 'admClientId', 'processingType' and one or both of 'visaADMOptionId'/'mcADMOptionId'. Omitted for virtualAccountType '2' or '4'. | No |

#### RvaReconciliationFileConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the RVA recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the RVA recon file outbound.  The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound RVA recon file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the RVA recon file needs to be generated. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| templateId | string | Denotes the id of the recon template to be used for generating the RVA reconciliation file. Valid values are 1 - RVA Recon standard template Version 1.0 | No |
| deliveryTime | string | Denotes the delivery type or day when the RVA recon file needs to be generated and delivered.  Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| deliveryFrequency | integer | Denotes the frequency in which the RVA recon file needs to be delivered.  Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the RVA recon file in their VOL mailbox. | No |

#### BillingConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| billingBID | string | The 11 digit Visa Billing BID that will be billed for the service. This is in the format of 8 digit Visa BID plus 3 digit country code. E.g. 12345678840 where 840 is country code for United States. | No |
| billingType | string | Identifies who will be billed for use of the service.  I indicates issuer will be billed (standard). T indicates Third party / fintech will be billed. M indicates manual billing is set up. | No |

#### Overrides Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| sequence | string | Sequence number for the override<br>*Example:* `"0"` | No |
| overrideCode | string | Code for the override type<br>*Example:* `"MCC"` | No |
| overrideValue | string | Value for the override<br>*Example:* `"5411"` | No |

#### BoostPaymentConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| boostPaymentEnabled | boolean | Denotes if Boost payments is enabled for the buyer.  Valid values are 'True' or 'False'. This field can be set to true only if the bank Boost Payment option is set to  'True'. You can enable Boost payments for a buyer at any time.  But you cannot disable it (update it to false) if there are Boost suppliers present for the buyer | No |

#### GetBuyerFeatureConfigV2-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| vcfDataFeedIndicator | string | Denotes if the financial institution will be providing buyer/business(VCF) data for the buyer. Valid Values are 'Y' and 'N'. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers). | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers). | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers). | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyer). | No |

#### RvaReconciliationFileConfigForCreate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the RVA recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the RVA recon file outbound. Required if the file level is B. The Visa implementation team provides this value after the outbound RVA recon file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the RVA recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| templateId | string | Denotes the id of the recon template to be used for generating the RVA reconciliation file. The template id is returned in the response when you create a new template.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the latest RVA recon standard template (currentyly 1).  Valid values are 1 - RVA Recon standard template Version 1.0 | No |
| deliveryTime | string | Denotes the delivery type or day when the RVA recon file needs to be generated and delivered. If the value for this field (the tag is not sent) is not provided, the system defaults it to'1:00' AM for the daily frequency and 1 for weekly and monthly frequency.   Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| deliveryFrequency | integer | Denotes the frequency in which the RVA recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the RVA recon file in their VOL mailbox. You can setup upto 80 user ids to receive the RVA recon file.The user ids should have the VOL mailbox service entitled to them. | No |

#### GetBillingConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| billingBID | string | The 11 digit Visa Billing BID that will be billed for the service. This is in the format of 8 digit Visa BID plus 3 digit country code. E.g. 12345678840 where 840 is country code for United States. | No |
| billingType | string | Identifies who will be billed for use of the service.  I indicates issuer will be billed (standard). T indicates Third party / fintech will be billed. M indicates manual billing is set up. | No |

#### GetBoostPaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| boostPaymentEnabled | boolean | Denotes if the Boost Payments is enabled for a template (buyer). | No |

#### BuyerFeatureConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12 | No |
| vcfDataFeedIndicator | string | Denotes if the financial institution will be providing buyer/business(VCF) data for the buyer. Valid Values are 'Y' and 'N'. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers). Valid Values are 'True' and 'False'.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   The value can be set to true only if the bank is enabled for this Option. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank setting for this field.   The value can be set to true only if the bank is enabled for this functionality. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12 | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.     The value can be set to true only if the bank is enabled for Online Payment Instructions. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   The value can be set to true only if the bank is enabled for Online Payment Requisitions. | No |

#### UpdateVanConfig-1 Schema

Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  Supports alphanumeric values. Required if the template is enabled for VANs. Can be set at any time if it is blank.  But cannot be changed if it is already set if the sync Buyer Profiles field is set to true. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  Can be set to true any time.  But cannot be disabled if the sync Buyer Profiles field is set to true. | No |

#### AuthorizationControlConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertsEnabled | boolean | Denotes if the system needs to send an alert when an authorization on a VPC enabled card is approved or declined. | No |
| issuerHoldingBID | string | Denotes the Holding BID (business id) for the issuer. | No |
| authControlEnabled | boolean | Denotes if the authorization controls needs to be enabled for the buyer.  Auth controls is mandated for VPP and VIP buyers. | No |
| defaultAuthControlEnabled | boolean | Denotes if the “Auth Control” option needs to be enabled by default for all the new suppliers created.<br>**Read-only** | No |
| authControlPaymentTemplate | string | Denotes the name of the email template which will be used for generating the email notifications if auth control is enabled.<br>**Read-only** | No |

#### WebServicesConfigForGetV2-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Denotes the codes associated with APIs which needs to be enabled for the buyer.  The APIs should be a subset of what is enabled for the bank.  The API codes and the corresponding APIs can be found below .... | No |
| clientId | string | Denotes the client id associated with the bank under which the buyer is being created.  The Visa implementation team will be providing this. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer. Valid Values are 'True' and 'False'. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. Valid Values are 'True' or 'False'. | No |

#### VanConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank FCS ID if there is only one setup at the bank level. Supports alphanumeric values. Required if the template is enabled for VANs. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |

#### UpdateProcessorConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| closeAccount | boolean | Used to close an account | No |

#### Invoices Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| invoiceDate | string | This contains the date of the invoice being paid. Format is MM/DD/YY. | No |
| invoiceAmount | string | Invoice amount. maximum length is 16. Maximum number of decimals is two. Format is XXXXXXXXXX9999.99 | No |
| invoiceNumber | string | Invoice Number. | No |
| purchaseOrderDate | string | This contains the date on which the  purchase order was created. Format is MM/DD/YY. | No |
| purchaseOrderNumber | string | This contains the purchase order number associated with the invoice. | No |

#### PaymentNotificationConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dateFormat | string | Denotes the date format which will be used for parsing date fields in the payment files in EDI or CVV tab format. Should be one of the VPA system supported date formats. This field is required. Refer to <a href="/pages/B2B-virtual-account-payment-method-codes#date_formats">Date Formats</a> table. | Yes |
| defaultBuyerLanguageCode | string | Denotes the language which will be used in notifications sent to the buyer.  A valid locale (language code) should be provided. For example "en_US" for US english. If the value for this field is not provided, the system defaults it to 'en_US'. Refer to the <a href="/pages/B2B-virtual-account-payment-method-codes#language_codes">Language Code</a> table for langauge codes. | No |
| attachRemittanceFileDetails | boolean | Denotes if the remittance details file (containing the invoice details) will be attached to the payment advice notification while processig a payment.  Valid values are 'True' or 'False'. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to value set for this option for the bank.  This field can be set to true only if the bank attach remittance details file option is set to 'True'. | No |
| supplierReminderNotificationDays | string | Denotes the number of days before the payment expiration date when the system sends a reminder notification to the supplier. Optional Field.  If the value for this field (the tag is not sent) is not provided, the system defaults it to 7 days. Should be between 0 and 100. This value should be specified only when suppress supplier notification is disabled and supplier reminder notification is enabled for the template. | No |
| supplierReminderNotificationEnabled | boolean | Denotes if the system will send the payment reminder notification to the supplier (before the configured number of days (supplier reminder notification days) from the payment expiration date) to remind them to collect the payment.   If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False' if the suppress supplier notification is enabled and to 'True' if the suppress supplier notifiation is disabled.  This field can be set to true only if the bank supplier reminder notification option is set to 'True' and suppress supplier notification option for the template is set to false. | No |

#### BoostPaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| boostPaymentEnabled | boolean | Denotes if the Boost Payments is enabled for a template (buyer). Valid values are 'True' or 'False'. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'.  This field can be set to true only if the bank Boost Payments option is set to  'True'. | No |

#### UpdateBuyerTemplateSuccessResponse Schema

Update Buyer Template Success Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"templateId"**: string } | Update Buyer Template Response | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### Response-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseCode | string | Response code indicating the result of the operation<br>*Example:* `"BGST0000"` | No |
| responseDescription | string | Human-readable description of the response<br>*Example:* `"Success"` | No |

#### UpdateBuyerTemplateRequest Schema

Update Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | Denotes the client ID associated with the bank for which the template is being defined.  Should be alphanumeric and should exist in the system.  Visa will provide this during implementation.  This field cannot be updated. | Yes |
| messageId | string | Unique identifier for this request.  Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the CreateTemplate API. | Yes |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template.  Can be updated at any time. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| syncBuyerProfiles | boolean | - Valid values are True or False - If set to Y, all existing buyers associated with this template will adopt these changes. Updating existing buyers could disrupt payments in progress so before syncing profiles, ensure there will be no negative impacts to existing buyers. If set to N, changes will only be applied to future buyers created after the update Template API is sent. | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Supports AlphaNumeric characters. Can be updated at any time. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |

#### Response-2 Schema

Overall request-level status code and description.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseCode | string | Result code for the request. "00" = Request Processed Successfully; "01" = Request processed partially (some accounts succeeded, some failed); "02" = Request could not be processed successfully. For request-level failures (schema/business validation, malformed request, unsupported method or media type, or an internal system error), a specific numeric error code is returned instead (e.g. "400" for a malformed/unsupported request, "7014" for a system exception, or a validation error code such as "7300", "120354"). | No |
| responseDescription | string | Human-readable description corresponding to the responseCode. | No |

#### UpdatePaymentFileCommConfig Schema

PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| edi824FileId | string | Denotes the Comm File ID associated with the EDI 824 outbound response file. This field Can be edited at any time. | No |
| edi997FileId | string | Denotes the Comm File ID associated with the EDI 997 outbound ack file. This field Can be edited at any time. | No |
| inboundFileId | string | Denotes the Comm file ID associated with the EDI 820 inbound payment file. This field Can be edited at any time. | No |

#### BoostPaymentConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| boostPaymentEnabled | boolean | Denotes if Boost payments is enabled for the buyer.  Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'. Valid values are 'True' or 'False'. This field can be set to true only if the bank Boost Payment option is set to  'True'. | No |

#### BillingConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| billingBID | string | The 11 digit Visa Billing BID that will be billed for the service. This is in the format of 8 digit Visa BID plus 3 digit country code. E.g. 12345678840 where 840 is country code for United States. | No |
| billingType | string | Identifies who will be billed for use of the service.  I indicates issuer will be billed (standard). T indicates Third party / fintech will be billed. M indicates manual billing is set up. | No |

#### UpdatePaymentNotificationConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dateFormat | string | Denotes the date format which will be used for parsing date fields in the payment files in EDI or CVV tab format. Should be one of the VPA system supported date formats. This field can be updated at any time. Refer to <a href="/pages/B2B-virtual-account-payment-method-codes#date_formats">Date Formats</a> table. | No |
| defaultBuyerLanguageCode | string | Denotes the language which will be used in notifications sent to the buyer.  A valid locale (language code) should be provided. For example "en_US" for US english. Refer to the <a href="/pages/B2B-virtual-account-payment-method-codes#language_codes">Language Code</a> table for langauge codes. This field can be updated at any time. | No |
| attachRemittanceFileDetails | boolean | Denotes if the remittance details file (containing the invoice details) will be attached to the payment advice notification while processig a payment. Valid values are 'True' or 'False'. This field can be set to true only if the bank attach remittance details file option is set to 'True'.  This field can be edited at any time. | No |
| supplierReminderNotificationDays | string | Denotes the number of days before the payment expiration date when the system sends a reminder notification to the supplier. Should be between 0 and 100. This value should be specified only when suppress supplier notification is disabled and supplier reminder notification is enabled for the template. This field can be edited at any time. | No |
| supplierReminderNotificationEnabled | boolean | Denotes if the system will send the payment reminder notification to the supplier (before the configured number of days (supplier reminder notification days) from the payment expiration date) to remind them to collect the payment. This field can be set to true only if the bank supplier reminder notification option is set to 'True' and suppress supplier notification option for the template is set to false.  This field can be edited at any time. | No |

#### UpdateProxyConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| holdDays | string | Denotes the number of days an account picked up for a payment in a proxy will be kept on hold before being used for another payment.  For payments, the hold days start from the day the payment was processed and for Request Virtual Account, the hold days start from the day the end date of the RVA has reached. Should be a numeric value between 1 to 999. If the value for this field (the tag is not sent) is not provided, the system defaults it to 90 days.  This field Can be edited at any time. | No |
| autoRefreshEnabled | boolean | Denotes if auto replenishment is enabled for proxies associated with the template (buyers).  The value of this field should be set to true for VIP and VPP enabled buyers.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for auto replenishment.  This field Can be edited at any time. | No |
| bucketedProxyEnabled | boolean | Denotes if bucketed proxy is enabled for proxies associated with the template (buyers). Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.    The value can be set to true only if the bank is enabled for bucketed proxy. This field Can be edited at any time. | No |

#### ErrorItem-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorCode | string | POP Error Code | No |
| errorDescription | string | POP Error Description | No |

#### GetBuyerFeatureConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers). | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers). | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers). | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyer). | No |

#### WebServicesConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Denotes the codes associated with APIs which needs to be enabled for the buyer.  The APIs should be a subset of what is enabled for the bank.  The API codes and the corresponding APIs can be found below .... | No |
| clientId | string | Denotes the client id associated with the bank under which the buyer is being created.  The Visa implementation team will be providing this. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer. Valid Values are 'True' and 'False'. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. Valid Values are 'True' or 'False'. | No |

#### BatchRequisitionsResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| nextPage | integer | Next page number (null if no more pages)<br>*Example:* `2` | No |
| messageId | string | Message identifier echoed from the request<br>*Example:* `"MSG-2024-001"` | No |
| responses | [ { **"responseCode"**: string, **"responseDescription"**: string } ] | Array of response codes and descriptions | No |
| totalPages | integer | Total number of pages available for pagination<br>*Example:* `5` | No |
| currentPage | integer | Current page number<br>*Example:* `1` | No |
| accountNumbers | [ { **"accountNumber"**: string, **"expirationDate"**: string } ] | Array of account numbers with expiration dates | No |
| bulkReferenceID | string | Bulk reference ID for tracking the batch<br>*Example:* `"BRK-20241124-001"` | No |
| totalAccountsCount | integer | Total number of accounts requested in the bulk requisition<br>*Example:* `100` | No |
| totalAccountsCreated | integer | Total number of accounts successfully created<br>*Example:* `98` | No |

#### GetBuyerResponseV2 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } |  | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### AccountNumber Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| accountNumber | string | The generated virtual account number<br>*Example:* `"4111111111111111"` | No |
| expirationDate | string | Expiration date of the virtual account in MMYY format<br>*Example:* `"1225"` | No |

#### GetBulkRequisitionRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string, <br>**Available values:** "G" | Action type - 'G' for Get/Read bulk requisition status<br>*Enum:* `"G"`<br>*Example:* `"G"` | Yes |
| buyerId | string | Unique identifier for the buyer<br>*Example:* `"67890"` | Yes |
| clientId | string | Unique identifier for the client<br>*Example:* `"12345"` | Yes |
| messageId | string | Unique message identifier for tracking<br>*Example:* `"MSG-2024-001"` | Yes |
| pageNumber | integer | Page number for pagination of results (required, minimum value is 1)<br>*Example:* `1` | Yes |
| bulkReferenceID | integer | Bulk reference ID returned from the original bulk requisition request<br>*Example:* `3811` | Yes |

#### AuthorizationControlConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertsEnabled | boolean | Denotes if the system needs to send an alert when an authorization on a VPC enabled card is approved or declined.  Valid values are 'True' and 'False'. This field can be set to True only if the authControlEnabled is set to true for the buyer. The alerts will be sent to the buyer contact's email address.  This field can be updated at any time. | No |
| issuerHoldingBID | string | Denotes the Holding BID (business id) for the issuer.  Should be numeric. This field can be updated only if there are no accounts setup for the buyer. | No |
| authControlEnabled | boolean | Denotes if the authorization controls needs to be enabled for the buyer.  Auth controls is mandated for VPP and VIP buyers.  You can enable auth controls for a buyer at any time.  But you cannot disable it (update it to false) if there are accounts enabled for VPC present for the buyer | No |

#### UpdateBuyerFeatureConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12. This field can be edited at any time. | No |
| vcfDataFeedIndicator | string | The vcfDataFeedIndicator is used for indicating the source of transactions/settlement data for this company. This value should be “Yes” if the FI/Processor is going to send settled transactions for the company [e.g. inbound Visa Commercial Format (VCF)]. It should be “No” if the company requires Visa to pull the settlement data over the Visa Network.hello | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. This field can be edited only if the sync Buyer Profiles is set to false. If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this functionality.  This field can be edited at any time. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12.  This field can be edited at any time. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'.  The value can be set to true only if the bank is enabled for Online Payment Instructions. This field can be edited at any time. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Requisitions. This field can be edited at any time. | No |

#### Schedule Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| frequencyType | string | Frequency of the notification to be scheduled recursively | No |
| scheduledTime | string | Notification schedule time to send a notification | No |

#### NotificationResponse Schema

Notification Generation Response Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request | No |
| statusCode | integer | HTTP Success status code | No |
| statusDescription | string | Success Message description | No |

#### BuyerFeatureConfigForUpdate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12.  This field can be updated at any time. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be enabled (set to true) but can not be disabled (set to false). | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this functionality. This field can be updated at any time. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12.  This field can be updated at any time. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer. Valid Values are 'True' and 'False'.  The value can be set to true only if the bank is enabled for Online Payment Instructions.  This field can be updated at any time. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Requisitions. This field can be updated at any time. | No |

#### GetBuyerTemplateSuccessResponse Schema

Get Buyer Template Success Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### ProcessPaymentResponse Schema

Process Payment Response Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request | Yes |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error code returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| accountNumber | string | Account number used for processing the payment. The account number will be masked in the response if the corresponding Client ID is configured to be masked. | No |
| expirationDate | string | The date the card account expires. Format is MM/YYYY Note- The card account expiration date is sent for all Payment Requisitions and Single Use Account payments. | Yes |

#### BoostPaymentConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| boostPaymentEnabled | boolean | Denotes if Boost payments is enabled for the buyer. | No |

#### GetBuyerTemplateSuccessResponseV2-4 Schema

Get Buyer Template Success Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response V2 | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### RvaReconciliationFileConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the RVA recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. This field can be updated at any time. | No |
| commFileId | string | Denotes the Comm File ID associated with the RVA recon file outbound. The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound RVA recon file configuration has been completed. This field can be updated at any time. | No |
| fileFormat | integer | Denotes the format in which the RVA recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1. This field can be updated at any time. | No |
| templateId | string | Denotes the id of the recon template to be used for generating the RVA reconciliation file.  Valid values are 1 - RVA Recon standard template Version 1.0. This field can be updated at any time. | No |
| deliveryTime | string | Denotes the delivery type or day when the RVA recon file needs to be generated and delivered.    Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 This field can be updated at any time. | No |
| deliveryFrequency | integer | Denotes the frequency in which the RVA recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly. This field can be updated at any time. | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the RVA recon file in their VOL mailbox. You can setup upto 50 user ids to receive the RVA recon file.The user ids should have the VOL mailbox service entitled to them. This field can be updated at any time. | No |

#### UpdateContactInfo Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| phone1 | string | Denotes the buyer contact phone number. Should be alphanumeric Can be updated at any time.  Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| emailAddress | string | Denotes the buyer's contact Email Address.  Should be an valid email address. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.  Select 1 if buyer will use VPA user interface  (issuer direct use of VPA).  Select 2 if buyer is created by a third party fintech and will use the VPA APIs.  Select 3 if buyer is created in VPA for Visa Commercial Pay service. | No |

#### VanConfigForUpdate-1 Schema

Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  Supports alphanumeric values. Required if the buyer is enabled for VANs. This field can be updated only if there are no VANs in the system associated to the buyer. This field can be set at any time but cannot be over ridden (Changed). This value will be provided by the Visa implementation team. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be enabled (Set to True) but cannot be disabled (Set to False).This value will be provided by the Visa implementation team. | No |
| admClientId | string | Denotes the number the TSYS VPP system uses to identify the company on the ACE Decision Max system for account assignment. This field can be set at any time but cannot be over ridden (Changed).This value will be provided by the Visa implementation team. | No |
| mcADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. If it is a mastercard bank, then this field is required.  This value will be provided by the Visa implementation team. This field can be set at any time but cannot be over ridden (Changed). | No |
| processingType | string | Denotes the Processing type for the virtual account number (VAN). This field can be set at any time but cannot be over ridden (Changed). This value will be provided by the Visa implementation team. | No |
| visaADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. If it is a Visa bank, then this field is required.  This field can be set at any time but cannot be over ridden (Changed). This value will be provided by the Visa implementation team. | No |

#### GetWebServicesConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] |  | No |
| clientId | string | Denotes the client ID associated with the bank for which the template is being defined. Visa will provide this during implementation. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the template (Buyer). | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. | No |

#### GetVanConfig Schema

Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the template (buyers). | No |

#### AdditionalParameter-1 Schema

Name/value pair carrying one additional virtual account setting at the buyer template level. Only 'fcsBankId' is persisted on a template.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| parameterName | string, <br>**Available values:** "fcsBankId" | Name of the parameter. Only 'fcsBankId' is supported at the template level — any other key is rejected (error VVC012).<br>*Enum:* `"fcsBankId"` | Yes |
| parameterValue | string | Value of the parameter. | Yes |

#### GetResponseFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. | No |

#### RvaReconciliationFileConfigForGet-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the RVA recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the RVA recon file outbound.  The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound RVA recon file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the RVA recon file needs to be generated. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| templateId | string | Denotes the id of the recon template to be used for generating the RVA reconciliation file. Valid values are 1 - RVA Recon standard template Version 1.0 | No |
| deliveryTime | string | Denotes the delivery type or day when the RVA recon file needs to be generated and delivered.  Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| deliveryFrequency | integer | Denotes the frequency in which the RVA recon file needs to be delivered.  Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the RVA recon file in their VOL mailbox. | No |

#### GetBuyerResponseV2-3 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } |  | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### GetBuyerResponseV2-4 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| virtualAccountConfig | [ { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId", **"parameterValue"**: string } ] } ] | Virtual account configuration for the buyer. Although this field is an array, only a single configuration is supported per buyer. The response therefore contains at most one entry. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### NotificationRequest Schema

Notification Generation Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| source | string | Value to identify from where this API request is originated | No |
| buyerId | string | Buyer ID is the buyer identifier as defined in Visa Payables Automation. | Yes |
| issuerId | string | A '-' (hyphen) separated field which contains the region id, processor id and bank id | Yes |
| language | string | Language in which the Notification to be sent | No |
| priority | string | Priority to be set for this Notification (high, low or medium) | No |
| schedule | { **"frequencyType"**: string, **"scheduledTime"**: string } |  | No |
| messageId | string | Unique identifier specific for this API request | Yes |
| parameters | object | Additional Key value pairs to be sent as placeholder for Notification Templates | No |
| recipients | { **"sms"**: [ string ], **"email"**: [ string ] } | Recipients of the Notification | No |
| templateId | string | Template id selected based on Notification Type | No |
| productName | string | Product name value to identify the Notification Request | Yes |
| notificationType | string | Type of the Notification to be sent | Yes |
| notificationStatus | string | Used to do Lifecycle management of Notification Request | No |

#### WebServicesConfigForGet-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Denotes the codes associated with APIs which needs to be enabled for the buyer.  The APIs should be a subset of what is enabled for the bank.  The API codes and the corresponding APIs can be found below .... | No |
| clientId | string | Denotes the client id associated with the bank under which the buyer is being created.  The Visa implementation team will be providing this. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer. Valid Values are 'True' and 'False'. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. Valid Values are 'True' or 'False'. | No |

#### CreateBuyerRequest Schema

Buyer Profile Details for creating a new buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } |  | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### StpPaymentConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stpPaymentEnabled | boolean | Denotes if STP payments is enabled for the buyer.  Valid values are 'True' or 'False'. This field can be set to true only if the bank STP Payment option is set to  'True'.  You can enable STP payments for a buyer at any time.  But you cannot disable it (update it to false) if there are STP suppliers present for the buyer. | No |
| accountHolderLastName | string | Denotes the Account Holder's last Name which will be used while processing the STP payment. This field can be edited at any time. | No |
| accountHolderFirstName | string | Denotes the Account Holder's first Name which will be used while processing the STP payment. This field can be edited at any time. | No |
| remittanceNotificationEnabled | boolean | Denotes if the STP Payment Remittance notification is enabled for a buyer.  Optional field. Valid values are 'True' or 'False'. This field can be set to true only if the bank STP Payment Remittance Notification option is set to 'True'. The STP supplier will be getting the payment remittance notification only if this field is enabled. This field can be edited at any time. | No |

#### ReconciliationFileConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company.  This field can be updated at any time. | No |
| commFileId | string | Denotes the Comm File ID associated with the recon file outbound.  The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound recon file configuration has been completed. This field can be updated at any time. | No |
| fileFormat | integer | Denotes the format in which the recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1.   This field can be updated at any time. | No |
| deliveryTime | string | Denotes the delivery type or day when the recon file needs to be generated and delivered. If the value for this field (the tag is not sent) is not provided, the system defaults it to'1:00' AM for the daily frequency and 1 for weekly and monthly frequency.   Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31. This field can be updated at any time. | No |
| templateName | string | Denotes the name of the recon template to be used for generating the reconciliation file.  This field can be updated at any time. | No |
| deliveryFrequency | integer | Denotes the frequency in which the recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly. This field can be updated at any time. | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the recon file in their VOL mailbox. You can setup upto 50 user ids to receive the recon file. The user ids should have the VOL mailbox service entitled to them.This field can be updated at any time. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Adhoc Reconciliation.  This field can be updated at any time. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the buyers.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Reconciliation.  This field can be updated at any time. | No |

#### GetPaymentDetailsRequest Schema

Get payment details request payload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string | Status of payment.  If you would like to get the details of payments in a particular status, you can pass it in this field.  The status will be used along with the date range filter if specified to get the payments.  <br> Valid values are M-Matched, U- UnMatched, R-Rejected, E-Expired, O-Error, A-All, C-Canceled. | No |
| toDate | string | Specifies the end of date range. Format is MMDDYYYY | No |
| buyerId | string | Buyer ID is the buyer identifier as defined in Visa Payables Automation. Value format is 09. | Yes |
| fromDate | string | Specifies the beginning of date range for which the payment details is requested. Format is MMDDYYYY. If "FromDate" and "ToDate" is not provided, the system will retrieve the last 9 months data. <br> <br>Note-  The system retrieves only last 250 payments made during the specified date range sent in the initial request. User can make subsequent calls to retrieve additional data. | No |
| issuerId | string | A '-' (hyphen) separated field which contains the region id, processor id and bank id | Yes |
| clientKey | string | Client key for secure communication | No |
| messageId | string | Unique ID specific to this API call. | Yes |
| resultSetNo | string | Result Set Number. | No |
| codeChallenge | string | Code Challenge for secure communication | No |
| trackingNumber | string | The MessageID of the original process payment request for which the payment is needed. | No |

#### CardEligibilityResponseError Schema

Response object containing card eligibility information

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier for the request message that references the original request<br>*Example:* `"123456781234123412341234567890AB"` | No |
| isEligible | boolean | Boolean flag indicating whether the card is eligible for the requested service<br>*Example:* `false` | No |
| statusCode | string | Status code indicating the result of the eligibility check<br>*Example:* `"CES001"` | No |
| errorResponse | { **"errorList"**: [ { **"code"**: string, **"description"**: string } ] } | Error response containing a list of error details | No |
| statusDescription | string | User‑friendly status message<br>*Example:* `"Card is not eligible"` | No |

#### BErrorItem Schema

Error Item

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorCode | string |  | No |
| errorDescription | string |  | No |

#### ResponseFileConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the response COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B and C.  This can be updated at any time. | No |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound response file configuration has been completed.  This can be updated at any time. | No |
| fileFormat | integer | Denotes the format in which the response file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1.  This field can be updated at any time. | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the response file in their VOL mailbox.  You can setup upto 50 user ids to receive the response file. The user ids should have the VOL mailbox service entitled to them.  This can be updated at any time. | No |

#### ContactInfo Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| phone1 | string | Buyer contact phone number. Should be alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| emailAddress | string | Denotes the buyer's contact Email Address.  Should be an valid email address. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.1 denotes buyer uses VPA UI (issuer direct use of VPA).  2 denotes buyer uses a third party fintech's user interface and third party is using VPA APIs. 3 denotes buyer uses Visa Commercial Pay service. | No |

#### VanConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  Supports alphanumeric values. Required if the buyer is enabled for VANs. This field can be updated only if there are no VANs in the system associated to the buyer. This field can be set at any time but cannot be over ridden (Changed). This value will be provided by the Visa implementation team. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be enabled (Set to True) but cannot be disabled (Set to False).This value will be provided by the Visa implementation team. | No |
| admClientId | string | Denotes the number the TSYS VPP system uses to identify the company on the ACE Decision Max system for account assignment. This field can be set at any time but cannot be over ridden (Changed).This value will be provided by the Visa implementation team. | No |
| mcADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. If it is a mastercard bank, then this field is required.  This value will be provided by the Visa implementation team. This field can be set at any time but cannot be over ridden (Changed). | No |
| processingType | string | Denotes the Processing type for the virtual account number (VAN). This field can be set at any time but cannot be over ridden (Changed). This value will be provided by the Visa implementation team. | No |
| visaADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. If it is a Visa bank, then this field is required.  This field can be set at any time but cannot be over ridden (Changed). This value will be provided by the Visa implementation team. | No |

#### GetBuyerTemplateSuccessResponseV2-1 Schema

Get Buyer Template Success Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response V2 | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### BuyerFeatureConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12 | No |
| vcfDataFeedIndicator | string | The vcfDataFeedIndicator is used for indicating the source of transactions/settlement data for this company. This value should be “Yes” if the FI/Processor is going to send settled transactions for the company [e.g. inbound Visa Commercial Format (VCF)]. It should be “No” if the company requires Visa to pull the settlement data over the Visa Network.   | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank setting for this field.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this functionality. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12 | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'.  The value can be set to true only if the bank is enabled for Online Payment Instructions. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Requisitions. | No |

#### GetBuyerTemplateSuccessResponseV2-2 Schema

Get Buyer Template Success Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response V2 | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### ErrorItem-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorCode | string | POP Notification Error Code | No |
| errorDescription | string | POP Notification Error Description | No |

#### ErrorItem-3 Schema

Individual error item containing error code and description

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| code | string | Error code identifying the specific type of error<br>*Example:* `"CES203"` | No |
| description | string | User‑friendly error message<br>*Example:* `"The account number you entered is not valid.Please check the number."` | No |

#### PaymentConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expirationDays | string | Default payment expiration days which will be used if the buyer did not provide the payment expiration date either in the payment or has not configured for the supplier.  The payment expiration days will be used to calculate the payment expiration date (payment process date + the payment expiration days) which is the last day by which the supplier should collect the payment. Only numbers are allowed. If the parameter is not provided, system default this value to 30. | No |
| billingCurrency | string | Denotes the ISO alpha currency code associated with the billing Currency of the card accounts belonging to the buyer. All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. VPA system uses the billing currency as the payment currency for adjustable limit card accounts. | No |
| allowableCurrencies | [ string ] | The list of currencies allowed for the buyer.  The buyer can process payments in any of these currencies.  Any payments made other than these currencies will be rejected.  All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. Can setup up to a max of 200 currencies. Billing currency should be present in the list else the system will automatically add it to the list. Defaults to the billing currency if not provided. | No |
| paymentAdviceOption | string | This option is used by the system to decide if all payments to the same supplier should be consolidated or sent separately in the payment advice notificaion.  Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'C'. Valid values are 'C' for consolidated or 'S' for split. | No |
| expirationBufferDays | string | expirationBufferDays is the number of days after the payment expiration date by which the supplier needs to complete the collection of the payment (settlement of the card transaction should be completed). Only numbers are allowed. If the parameter is not provided, system default this value to 5. | No |
| securityCodeRequired | boolean | Denotes if security code is needed for the supplier to collect the payment. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to the value set for the bank for this field. Valid values are 'True' or 'False'. This field can be set to true only if the bank security code (CVV2) option is set to  'True'. | No |

#### GetBuyerRequest Schema

Get Buyer Request Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| buyerId | string | Buyer ID is the buyer identifier as defined in Visa Payables Automation. This is often the ID defined at the processor. This will be provided by the Visa implementation team.  Value format is 0–9. | Yes |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request.   Each request sent to VPA requires its own unique ID. | Yes |

#### BuyerFeatureConfigForGet-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer. | No |

#### GetBulkRequisitionResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| batchRequisitionsResponse | { **"nextPage"**: integer, **"messageId"**: string, **"responses"**: [ { **"responseCode"**: string, **"responseDescription"**: string } ], **"totalPages"**: integer, **"currentPage"**: integer, **"accountNumbers"**: [ { **"accountNumber"**: string, **"expirationDate"**: string } ], **"bulkReferenceID"**: string, **"totalAccountsCount"**: integer, **"totalAccountsCreated"**: integer } |  | No |

#### ProxyConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| holdDays | string | Denotes the number of days an account picked up for a payment in a proxy will be kept on hold before being used for another payment.  For payments, the hold days start from the day the payment was processed and for Request Virtual Account, the hold days start from the day the end date of the RVA has reached. Should be a numeric value between 1 to 999. This field can be updated at any time. | No |
| autoRefreshEnabled | boolean | Denotes if auto replenishment is enabled for proxies associated with the buyer.  The value of this field should be set to true for VIP and VPP enabled buyers.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for auto replenishment. This field can be updated at any time. | No |
| bucketedProxyEnabled | boolean | Denotes if bucketed proxy is enabled for proxies associated with the buyer.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for bucketed proxy. This field can be updated only if all the proxy pools are empty. | No |

#### PaymentNotificationConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dateFormat | date | Denotes the date format which will be used for parsing date fields in the payment files in EDI or CSV or tab format. | No |
| settlementSource | string | Denotes if the settlement is sourced from VIDS (1) or from VCF (2).<br>**Read-only** | No |
| paymentAdviceTemplate | string | Denotes the name of the email template which will be used for generating the email notifications.<br>**Read-only** | No |
| defaultBuyerLanguageCode | string | Denotes the language which will be used in notifications sent to the buyer.<br>*Example:* `"en_us"` | No |
| attachRemittanceDetailsFile | boolean | Denotes if the remittance details file (containing the invoice details) will be attached to the payment advice notification while processig a payment. | No |
| supplierReminderNotificationDays | string | Denotes the number of days before the payment expiration date when the system sends a reminder notification to the supplier. | No |
| defaultAttachRemittanceDetailsFile | boolean | Denotes if the “Attach Remittance Details” option needs to be enabled by default for all the new suppliers created.<br>**Read-only** | No |
| supplierReminderNotificationEnabled | boolean | Denotes if the system will send the payment reminder notification to the supplier (before the configured number of days (supplier reminder notification days) from the payment expiration date) to remind them to collect the payment. | No |
| defaultSupplierReminderNotificationEnabled | boolean | Denotes if the “Reminder Notification” option needs to be enabled by default for all the new suppliers created.<br>**Read-only** | No |

#### UpdateBuyerSuccessResponse Schema

Response for a successful update of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### PaymentSecurityConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customSecurityQuestions | [ string ] | The questions (text) which will be used at random (Only one of the questions will be displayed) to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. The system sends the security questions and answers to the supplier when the supplier is setup for the buyer.  At least one question needs to be sent if custom security question is enabled for the buyer. This field can be updated at any time and will be used only for future payments. | No |
| defaultSecurityQuestion | string | Denotes the text for the default security question which will be displayed to the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  This field can be updated at any time and will be used only for future payments. | No |
| defaultSecurityFieldCode | string | Denotes the field system uses to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. Valid values are '1' - Postal code and '2' - Supplier ID. The default security is used only when the system creates new suppliers while processing payment files (EDI 820) or if custom security question is not enabled. This field can be updated at any time and will be used only for future payments. | No |
| customSecurityQuestionsEnabled | boolean | Denotes if the buyer wants to use custom security questions to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  Valid values are 'True' and 'False'. This field can be set to True only if the bank custom security questions option is set to True. This field can be updated at any time and will be used only for future payments. | No |

#### UpdatePaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expirationDays | string | Default payment expiration days which will be used if the buyer did not provide the payment expiration date either in the payment or has not configured for the supplier.  The payment expiration days will be used to calculate the payment expiration date (payment process date + the payment expiration days) which is the last day by which the supplier should collect the payment. Only numbers are allowed. This fiel can be updated at any time. | No |
| billingCurrency | string | Denotes the ISO alpha currency code associated with the billing Currency of the card accounts belonging to the buyer.  For example- USD for US Dollar. It should be one of the supported active currencies in VPA. VPA system uses the billing currency as the payment currency for adjustable limit card accounts. This field cannot be updated if sync Buyer Profiles field is set to true. | No |
| allowableCurrencies | [ string ] | Contains the list of ISO alpha currency codes allowed for the buyer.  The buyer can process payments only in one of these currencies.  Payments made in any other currency will be rejected.  All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. Can setup up to a max of 200 currencies. Billing currency should be present in the list else the system will automatically add it to the list. Defaults to the billing currency if not provided. This field cannot be updated if the sync Buyer Profiles is set to true. | No |
| paymentAdviceOption | string | Denotes if the payment advice should be sent at the consolidated payment level (Consolidated) or for each payment (split). Valid values are 'C' for consolidated or 'S' for split. If consolidated option is chosen, all payments to the same supplier will be consolidated and sent in one payment advice notification.  This field can be updated at any time. | No |
| expirationBufferDays | string | expirationBufferDays is the number of days after the payment expiration date by which the supplier needs to complete the collection of the payment (settlement of the card transaction should be completed). Only 2 digit integer numbers are allowed. Can be updated at any time. | No |
| securityCodeRequired | boolean | Denotes if security code is needed for the supplier to collect the payment.  Valid values are 'True' or 'False'. This field can be set to true only if the bank security code (CVV2) option is set to  'True'.  This field can be updated at any time. | No |

#### UpdateBuyerTemplateResponse Schema

Update Buyer Template Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the CreateTemplate API. | Yes |

#### GetBuyerTemplateResponseV2 Schema

Get Buyer Template Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the GetTemplate API. | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Description of the template. | No |
| virtualAccountConfig | { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", **"parameterValue"**: string } ] } | Virtual account configuration for a buyer template. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### UpdateBuyerRequest-2 Schema

Profile details of the buyer being updated.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for this request. Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| virtualAccountConfig | [ { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId", **"parameterValue"**: string } ] } ] | Virtual account configuration for the buyer. Although this field is an array, only a single configuration is supported per buyer. If more than one entry is sent, only the first entry is considered and the remaining entries are ignored. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### WebServicesConfigForCreate-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Reserved for Future use. The system will default the apiCodes to what is set for the bank. | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves.   If the value for this field (the tag is not sent) is not provided, the system defaults it to False. Valid Values are 'True' or 'False'. | No |

#### UpdateBuyerRequest-3 Schema

Profile details of the buyer being updated.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for this request. Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } |  | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### GetBuyerTemplateSuccessResponseV2 Schema

Get Buyer Template Success Response V2

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean }, **"templateId"**: string, **"contactInfo"**: { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"templateName"**: string, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"closeAccount"**: boolean }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"commFileId"**: string }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"templateDescription"**: string, **"virtualAccountConfig"**: { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", **"parameterValue"**: string } ] }, **"paymentFileCommConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] }, **"reconciliationFileConfig"**: { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean }, **"rvaReconciliationFileConfig"**: { **"commFileId"**: string, **"templateId"**: string } } | Get Buyer Template Response V2 | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### CreateBuyerTemplateSuccessResponse Schema

Create Buyer Template Success Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"templateId"**: string } | Create Buyer Template Response | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### UpdateBuyerRequest-1 Schema

Profile details of the buyer being updated.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID uniquely identifies a financial institution. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for this request. Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string } |  | No |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | Yes |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"processorFields"**: object, **"closeAccountEnabled"**: boolean } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### WebServicesConfigForCreate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Reserved for Future use. The system will default the apiCodes to what is set for the bank. | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves.   If the value for this field (the tag is not sent) is not provided, the system defaults it to False. Valid Values are 'True' or 'False'. | No |

#### VanConfigForCreate-1 Schema

Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  This value will be provided by the Visa implementation team. If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank FCS ID if there is only one setup at the bank level. Supports alphanumeric values. Required if the buyer is enabled for VANs. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| admClientId | string | Denotes the number the TSYS VPP system uses to identify the company on the ACE Decision Max system for account assignment. This value will be provided by the Visa implementation team. | No |
| mcADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. This value will be provided by the Visa implementation team.  If it is a Mastercard  bank, then this field is required. | No |
| processingType | string | Denotes the Processing type for the virtual account number (VAN). This value will be provided by the Visa implementation team. | No |
| visaADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. If it is a Visa bank, then this field is required. This value will be provided by the Visa implementation team. | No |

#### GetRVAReconciliationFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Comm file Id refers to Comm File info associated with the Request Virtua Account recon file outbound delivery. | No |
| templateId | string | Denotes the template identifier associated with the RVA recon template to be used for generating the RVA recon file. | No |

#### CreateBuyerTemplateRequest Schema

Create Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID associated with the bank. This will be provided by Visa implementation team. | Yes |
| messageId | string | Unique identifier for identifying the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Client-provided name of the template. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | Yes |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | Yes |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"commFileId"**: string } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Client-defined template description. Supports AlphaNumeric characters. | No |
| paymentFileCommConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } | PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"commFileId"**: string, **"templateName"**: string, **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | Yes |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |
| rvaReconciliationFileConfig | { **"commFileId"**: string, **"templateId"**: string } |  | No |

#### UpdatePaymentConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expirationDays | string | Default payment expiration days which will be used if the buyer did not provide the payment expiration date either in the payment or has not configured for the supplier.  The payment expiration days will be used to calculate the payment expiration date (payment process date + the payment expiration days) which is the last day by which the supplier should collect the payment. Only numbers are allowed. This field can be updated at any time. | No |
| billingCurrency | string | Denotes the ISO alpha currency code associated with the billing Currency of the card accounts belonging to the buyer.  For example- USD for US Dollar. It should be one of the supported active currencies in VPA. VPA system uses the billing currency as the payment currency for adjustable limit card accounts. This field cannot be updated if sync Buyer Profiles field is set to true. | No |
| allowableCurrencies | [ string ] | Contains the list of ISO alpha currency codes allowed for the buyer.  The buyer can process payments only in one of these currencies.  Payments made in any other currency will be rejected.  All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. Can setup up to a max of 200 currencies. Billing currency should be present in the list else the system will automatically add it to the list. Defaults to the billing currency if not provided. This field cannot be updated if the sync Buyer Profiles is set to true. | No |
| paymentAdviceOption | string | Denotes if the payment advice should be sent at the consolidated payment level (Consolidated) or for each payment (split). Valid values are 'C' for consolidated or 'S' for split. If consolidated option is chosen, all payments to the same supplier will be consolidated and sent in one payment advice notification.  This field can be updated at any time. | No |
| expirationBufferDays | string | expirationBufferDays is the number of days after the payment expiration date by which the supplier needs to complete the collection of the payment (settlement of the card transaction should be completed). Only 2 digit integer numbers are allowed. Can be updated at any time. | No |
| securityCodeRequired | boolean | Denotes if security code is needed for the supplier to collect the payment.  Valid values are 'True' or 'False'. This field can be set to true only if the bank security code (CVV2) option is set to  'True'.  This field can be updated at any time. | No |

#### ProcessPaymentRequest Schema

Process Payment Request Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| buyerId | string | Buyer ID is the buyer identifier as defined in Visa Payables Automation. | Yes |
| payment | { **"invoices"**: [ { **"invoiceDate"**: string, **"invoiceAmount"**: string, **"invoiceNumber"**: string, **"purchaseOrderDate"**: string, **"purchaseOrderNumber"**: string } ], **"supplier"**: { **"emailNotes"**: string, **"supplierID"**: string, **"supplierCity"**: string, **"supplierName"**: string, **"supplierState"**: string, **"supplierPostalCode"**: string, **"primaryEmailAddress"**: string, **"supplierCountryCode"**: string, **"supplierAddressLine1"**: string, **"supplierAddressLine2"**: string, **"alternateEmailAddresses"**: [ { **"alternateEmailAddress"**: string } ] }, **"accountType"**: string, **"paymentType"**: string, **"accountLimit"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"paymentExpiryDate"**: string, **"paymentGrossAmount"**: string, **"paymentRequestDate"**: string, **"cardAccountExpiryDate"**: string } | Payment Class | Yes |
| issuerId | string | A '-' (hyphen) separated field which contains the region id, processor id and bank id | Yes |
| clientKey | string | Client key for secure communication | No |
| messageId | string | Unique ID specific to this API call. | Yes |
| actionType | string | Type of payment processing.     1 - Payment Instruction      2 - Payment Requisition | Yes |
| codeChallenge | string | Code challenge for secure communication | No |
| accountingSoftware | string, <br>**Available values:** "QBO" | Name/Initials of the accounting software used.<br>*Enum:* `"QBO"` | Yes |
| paymentDescription | string | Description of the payment. | No |
| accountingSoftwareEntityId | string | Unique ID of that particular accounting software entity<br>*Example:* `"bill Id with respect to QuickBooks Online(QBO)"` | Yes |

#### Supplier Schema

Supplier Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emailNotes | string | This contains the text to be included on email notifications and remittance advice. | No |
| supplierID | string | Identifier used by the buyer to identify the supplier. This has to be unique for a buyer. It cannot contain spaces. | Yes |
| supplierCity | string | Supplier city. | No |
| supplierName | string | Name of supplier to be paid. It is mandatory for new suppliers. | Yes |
| supplierState | string | Supplier state. | No |
| supplierPostalCode | string | Supplier postal code. It is mandatory for new suppliers and only if the country mandates it. | No |
| primaryEmailAddress | string | Email address | No |
| supplierCountryCode | string | Supplier country code. It is alphanumeric. VPA supports all ISO alphanumeric country code.For example- USA. | No |
| supplierAddressLine1 | string | Supplier address line 1. | No |
| supplierAddressLine2 | string | Supplier address line 2. | No |
| alternateEmailAddresses | [ { **"alternateEmailAddress"**: string } ] | This complex element can have up to five alternate email addresses. | No |

#### GetBuyerSuccessResponseV2 Schema

Response for a successful fetch of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseObject | { **"messageId"**: string, **"vanConfig"**: { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer }, **"statusCode"**: string, **"statusDesc"**: string, **"contactInfo"**: { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer }, **"proxyConfig"**: { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean }, **"billingConfig"**: { **"billingBID"**: string, **"billingType"**: string }, **"paymentConfig"**: { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean }, **"processorConfig"**: { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string }, **"stpPaymentConfig"**: { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean }, **"paymentFileConfig"**: { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string }, **"webServicesConfig"**: { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean }, **"boostPaymentConfig"**: { **"boostPaymentEnabled"**: boolean }, **"buyerFeatureConfig"**: { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean }, **"responseFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] }, **"stripePaymentConfig"**: { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean }, **"paymentSecurityConfig"**: { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean }, **"approvalWorkflowConfig"**: { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] }, **"reconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean }, **"paymentNotificationConfig"**: { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean }, **"authorizationControlConfig"**: { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string }, **"rvaReconciliationFileConfig"**: { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } } | Get Buyer Response Class | No |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### StripePaymentConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stripePaymentEnabled | boolean | Denotes if Stripe payments is enabled for the buyer. | No |
| remittanceNotificationEnabled | boolean | Denotes if the Stripe Payment Remittance notification is enabled for a buyer. The Stripe supplier will be getting the payment remittance notification only if this field is enabled. | No |

#### GetContactInfo Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| phone1 | string | Buyer contact phone number. Will be alphanumeric. | No |
| emailAddress | string | Denotes the buyer's contact Email Address.  Will be a valid email address. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.  1 denotes buyer uses VPA UI (issuer direct use of VPA).  2 denotes buyer uses a third party fintech's user interface and third party is using VPA APIs.  3 denotes buyer uses Visa Commercial Pay service. | No |

#### GetPaymentFileCommConfig Schema

PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| edi824FileId | string | Denotes the Comm File ID associated with the EDI 824 outbound response file. | No |
| edi997FileId | string | Denotes the Comm File ID associated with the EDI 997 outbound ack file. | No |
| inboundFileId | string | Denotes the Comm file ID associated with the EDI 820 inbound payment file. | No |

#### ApprovalWorkflowConfig Schema

Parent tag which contains the approval workflow configurations.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| workflowConfigEnabled | boolean | Denotes if the Approval Workflow is enabled for the template (Buyer).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it false.   The value can be set to true only if the bank is enabled for this Option. | No |
| workflowFunctionCodes | [ string ] |  | No |

#### GetBuyerFeatureConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers). If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers). | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers). | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyer). | No |

#### ReconciliationFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Comm file Id refers to Comm File info associated with the recon file outbound delivery.Required if ReconFileDelivery is set to Comms. | No |
| templateName | string | Denotes the name of the custom Reconciliation template to be used for generating the reconciliation file for all buyers using the template. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   The value can be set to true only if the bank is enabled for Adhoc Reconciliation. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   The value can be set to true only if the bank is enabled for Online Payment Reconciliation. | No |

#### GetApprovalWorkflowConfig Schema

Parent tag which contains the approval workflow configurations.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| workflowConfigEnabled | boolean | Denotes if the Approval Workflow is enabled for the template (Buyer). | No |
| workflowFunctionCodes | [ string ] |  | No |

#### PaymentNotificationConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dateFormat | date | Denotes the date format which will be used for parsing date fields in the payment files in EDI or CSV or tab format. Should be one of the VPA system supported date formats. This field can be updated at any time. Refer to <a href="/pages/B2B-virtual-account-payment-method-codes#date_formats">Date Formats</a> table. | No |
| defaultBuyerLanguageCode | string | Denotes the language which will be used in notifications sent to the buyer. A valid locale (language code) should be provided. For example "en_US" for US english. Refer to the <a href="/pages/B2B-virtual-account-payment-method-codes#language_codes">Language Code</a> table for langauge codes. This field can be updated at any time.<br>*Example:* `"en_us"` | No |
| attachRemittanceDetailsFile | boolean | Denotes if the remittance details file (containing the invoice details) will be attached to the payment advice notification while processig a payment.  Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to value set for this option for the bank. Valid values are 'True' or 'False'. This field can be set to true only if the bank attach remittance details file option is set to 'True'.  This field can be updated at any time. | No |
| supplierReminderNotificationDays | string | Denotes the number of days before the payment expiration date when the system sends a reminder notification to the supplier. Optional Field.  If the value for this field (the tag is not sent) is not provided, the system defaults it to 7 days. Should be between 0 and 100. This value should be specified only when suppress supplier notification is disabled and supplier reminder notification is enabled for the buyer. This field can be updated at any time. | No |
| supplierReminderNotificationEnabled | boolean | Denotes if the system will send the payment reminder notification to the supplier (before the configured number of days (supplier reminder notification days) from the payment expiration date) to remind them to collect the payment.   If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False' if the suppress supplier notification is enabled and to 'True' if the suppress supplier notifiation is disabled.  This field can be set to true only if the bank supplier reminder notification option is set to 'True' and suppress supplier notification option for the buyer is set to false.  This field can be updated at any time. | No |

#### GetProcessorConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| closeAccount | boolean | Used to close an account | No |

#### GetBuyerResponseV2-1 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } |  | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### GetBuyerResponseV2-2 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } |  | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"vbdsDataSubscription"**: [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ], **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### PaymentFileCommConfig Schema

PaymentFileCommConfig contains the comm file configuration for inbound EDI 820, and outbound EDI 997 and EDI 824.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| edi824FileId | string | Denotes the Comm File ID associated with the EDI 824 outbound response file | No |
| edi997FileId | string | Denotes the Comm File ID associated with the EDI 997 outbound ack file | No |
| inboundFileId | string | Denotes the Comm file ID associated with the EDI 820 inbound payment file | No |

#### UpdatePaymentSecurityConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customSecurityQuestions | [ string ] | The questions (text) which will be used at random (Only one of the questions will be displayed) to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. The system sends the security questions and answers to the supplier when the supplier is setup for the buyer.  At least one question needs to be sent if custom security question is enabled for the template. This can be edited at any time and will take into effect only for future payments. | No |
| defaultSecurityQuestion | string | Denotes the text for the default security question which will be displayed to the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. This field can be edited at any time. | No |
| defaultSecurityFieldCode | string | Denotes the field system uses to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. Valid values are '1' - Postal code and '2' - Supplier ID. If the value for this field (the tag is not sent) is not provided, the system defaults it to '1'.  The default security is used only when the system creates new suppliers while processing payment files (EDI 820) or if custom security question is not enabled. This field can be edited at any time. | No |
| customSecurityQuestionsEnabled | boolean | Denotes if the buyer wants to use custom security questions to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  Valid values are 'True' and 'False'. This field can be set to True only if the bank custom security questions option is set to True. This field can be edited at any time. | No |

#### BuyerFeatureConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer. If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer. | No |

#### ProcessorConfigForUpdate Schema

This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| processorFields | object |  | No |
| closeAccountEnabled | boolean | Default to Yes if processor integration is enabled for the bank. Default to N if Processor integration is not enabled for the bank. Default to Y if the buyer is enabled for VIP/VPP tokens. | No |

#### ReconciliationFileConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the recon file outbound. | No |
| fileFormat | integer | Denotes the format in which the recon file needs to be generated.   Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| deliveryTime | string | Denotes the delivery type or day when the recon file needs to be generated and delivered. Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| templateName | string | Denotes the name of the recon template to be used for generating the reconciliation file. | No |
| deliveryFrequency | integer | Denotes the frequency in which the recon file needs to be delivered.  Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the recon file in their VOL mailbox. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the buyer.  Valid Values are 'True' and 'False'. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the buyers.     Valid Values are 'True' and 'False'. | No |

#### RequisitionDetails Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| rules | [ { **"ruleCode"**: string, **"overrides"**: [ { **"sequence"**: string, **"overrideCode"**: string, **"overrideValue"**: string } ] } ] | Array of rules to apply to virtual accounts | No |
| endDate | string | End date for virtual account validity. Supported formats: YYYY-MM-DD or MM/DD/YYYY<br>*Example:* `"2024-12-31"` | No |
| timeZone | string | Time zone as UTC offset (e.g., UTC+05:30, UTC-08:00)<br>*Example:* `"UTC+05:30"` | No |
| startDate | string | Start date for virtual account validity. Supported formats: YYYY-MM-DD or MM/DD/YYYY<br>*Example:* `"2024-12-01"` | No |
| mcgRuleAction | string | MCG rule action<br>*Example:* `"ALLOW"` | No |

#### CancelPaymentResponse Schema

Cancel Payment Response Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table | Yes |
| statusDesc | string | Status description of the response. | Yes |
| supplierId | string | Identifier used by the buyer to identify the supplier. This is the supplier id of the supplier whose payment is being canceled. | No |
| grossAmount | string | Contains the payment gross amount of the payment being cancelled | Yes |
| supplierName | string | Name of supplier whose payment is being canceled. | Yes |

#### ResponseFileConfigForUpdate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the response COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B and C.  This can be updated at any time. | No |
| commFileId | string | Denotes the Comm File ID associated with the Response file outbound. The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound response file configuration has been completed.  This can be updated at any time. | No |
| fileFormat | integer | Denotes the format in which the response file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1.  This field can be updated at any time. | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the response file in their VOL mailbox.  You can setup upto 80 user ids to receive the response file. The user ids should have the VOL mailbox service entitled to them.  This can be updated at any time. | No |

#### ErrorResponse-4 Schema

Error response containing a list of error details

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorList | [ { **"code"**: string, **"description"**: string } ] | List of error items providing detailed error information | No |

#### WebServicesConfigForUpdate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Reserved for Future use. The system will default the apiCodes to what is set for the bank. | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric.  This field can be editedat any time. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be enabled at any time but cannot be disabled. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves.    Valid Values are 'True' or 'False'. This field can be updated at any time. | No |

#### Recipients Schema

Recipients of the Notification

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| sms | [ string ] | List of phone numbers | No |
| email | [ string ] | List of email recipients | No |

#### WebServicesConfigForUpdate-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Reserved for Future use. The system will default the apiCodes to what is set for the bank. | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric.  This field can be editedat any time. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be enabled at any time but cannot be disabled. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves.    Valid Values are 'True' or 'False'. This field can be updated at any time. | No |

#### PaymentNotificationConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dateFormat | date | Denotes the date format which will be used for parsing date fields in the payment files in EDI or CSV or tab format. Should be one of the VPA system supported date formats. This field is required. Refer to <a href="/pages/B2B-virtual-account-payment-method-codes#date_formats">Date Formats</a> table. | No |
| defaultBuyerLanguageCode | string | Denotes the language which will be used in notifications sent to the buyer.  A valid locale (language code) should be provided. For example "en_US" for US english. If the value for this field is not provided, the system defaults it to 'en_US'. Refer to the <a href="/pages/B2B-virtual-account-payment-method-codes#language_codes">Language Code</a> table for langauge codes.<br>*Example:* `"en_us"` | No |
| attachRemittanceDetailsFile | boolean | Denotes if the remittance details file (containing the invoice details) will be attached to the payment advice notification while processig a payment.  Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to value set for this option for the bank. Valid values are 'True' or 'False'. This field can be set to true only if the bank attach remittance details file option is set to 'True'. | No |
| supplierReminderNotificationDays | string | Denotes the number of days before the payment expiration date when the system sends a reminder notification to the supplier. Optional Field.  If the value for this field (the tag is not sent) is not provided, the system defaults it to 7 days. Should be between 0 and 100. This value should be specified only when suppress supplier notification is disabled and supplier reminder notification is enabled for the buyer. | No |
| supplierReminderNotificationEnabled | boolean | Denotes if the system will send the payment reminder notification to the supplier (before the configured number of days (supplier reminder notification days) from the payment expiration date) to remind them to collect the payment.   If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False' if the suppress supplier notification is enabled and to 'True' if the suppress supplier notifiation is disabled.  This field can be set to true only if the bank supplier reminder notification option is set to 'True' and suppress supplier notification option for the buyer is set to false. | No |

#### CancelPaymentErrorResponse Schema

Error Codes

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CP002 | object | The message ID sent in the request should be unique for each request. | No |
| CP003 | object | The client ID sent in the request is not found in the system. | No |
| CP004 | object | The buyer information sent in the request is not set up in the system. | No |
| CP025 | object | The bank or buyer has not been set up in VPA yet. | No |
| CP029 | object | The account number and the original message ID combination is not found in the system. | No |
| CP030 | object | The original message ID sent in the request is not be found in the system. | No |
| CP031 | object | The payment identified by the original message ID has already been collected by the supplier. | No |
| CP032 | object | Cancel payment is not supported for DPS buyers. | No |
| CP037 | object | A system error occurred while canceling the payment. Please try your request after sometime. If the issue persist, contact your system administrator. | No |
| CP038 | object | Cancel payment is not supported for STP payments. | No |
| CP161 | object | The payment identified by the original message ID has already been canceled. | No |
| CP162 | object | Payment is already canceled. | No |
| CP167 | object | The payment identified by the original message ID cannot be canceled because the original payment was not processed successfully. | No |

#### NotificationErrorResponse Schema

Notification Generation Error Response Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request | No |
| statusCode | integer | HTTP Error status code | No |
| errorResponse | { **"errorItems"**: [ { **"errorCode"**: string, **"errorDescription"**: string } ] } | Error Response Schema | No |
| statusDescription | string | HTTP Error status description | No |

#### GetPaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expirationDays | string | Default payment expiration days which will be used if the buyer did not provide the payment expiration date either in the payment or has not configured for the supplier.  The payment expiration days will be used to calculate the payment expiration date (payment process date + the payment expiration days) which is the last day by which the supplier should collect the payment. | No |
| billingCurrency | string | Denotes the ISO alpha currency code associated with the billing Currency of the card accounts belonging to the buyer. | No |
| allowableCurrencies | [ string ] | The list of currencies (ISO alpha currency codes) allowed for the buyer.  The buyer can process payments in any of these currencies.  Any payments made other than these currencies will be rejected. | No |
| paymentAdviceOption | string | Denotes if all payments to the same supplier in a payment file will be consolidated (Consolidated option - C) or sent separately (Split Option - S) and sent in one payment advice notification. | No |
| expirationBufferDays | string | expirationBufferDays is the number of days after the payment expiration date by which the supplier needs to complete the collection of the payment (settlement of the card transaction should be completed). | No |
| securityCodeRequired | boolean | Denotes if CVV2 is required for processing the payment. | No |

#### WebServicesConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] | Reserved for Future use. The system will default the apiCodes to what is set for the bank. | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system.  Field is alphanumeric.  This field can be editedat any time. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the Buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be enabled at any time but cannot be disabled. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves.    Valid Values are 'True' or 'False'. This field can be updated at any time. | No |

#### BResponse Schema

Default API Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "success", "error" | Response status `success` or `error`<br>*Enum:* `"success"`, `"error"` | No |
| messageId | string | Unique identifier which was sent in the request. | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | No |
| statusDesc | string | Status description of the response. | No |

#### UpdateBuyerFeatureConfig-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12. This field can be edited at any time. | No |
| vcfDataFeedIndicator | string | The vcfDataFeedIndicator is used for indicating the source of transactions/settlement data for this company. This value should be “Yes” if the FI/Processor is going to send settled transactions for the company [e.g. inbound Visa Commercial Format (VCF)]. It should be “No” if the company requires Visa to pull the settlement data over the Visa Network. | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. This field can be edited only if the sync Buyer Profiles is set to false. If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this functionality.  This field can be edited at any time. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12.  This field can be edited at any time. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'.  The value can be set to true only if the bank is enabled for Online Payment Instructions. This field can be edited at any time. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Requisitions. This field can be edited at any time. | No |

#### UpdateBuyerFeatureConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12. This field can be edited at any time. | No |
| vcfDataFeedIndicator | string | Denotes if the financial institution will be providing buyer/business(VCF) data for the buyer. Valid Values are 'Y' and 'N'. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. This field can be edited only if the sync Buyer Profiles is set to false. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this functionality.  This field can be edited at any time. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12.  This field can be edited at any time. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'.  The value can be set to true only if the bank is enabled for Online Payment Instructions. This field can be edited at any time. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyers).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Requisitions. This field can be edited at any time. | No |

#### GetVanConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the template (buyers). | No |

#### UpdateAuthorizationControlConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertsEnabled | boolean | Denotes if the system needs to send an alert when an authorization on a VPC enabled card is approved or declined.  Valid values are 'True' and 'False'. This field can be set to True only if the authControlEnabled is set to true for the template. This field can be edited only if the sync Buyer Profiles is set to false. | No |
| issuerHoldingBID | string | Denotes the Holding BID (business id) for the issuer.  Should be numeric. Should be set only if authControlEnabled is set to true for the template. This field can be edited only if the sync Buyer Profiles is set to false. | No |
| authControlEnabled | boolean | Denotes if the authorization controls needs to be enabled for the template (in turn the buyer).  Auth controls is mandated for VPP and VIP buyers. Valid values are true or false. This field can be edited only if the sync Buyer Profiles is set to false. | No |

#### BuyerFeatureConfigForCreate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. Should be Numeric. Should be between 4 and 12 | No |
| vcfDataFeedIndicator | string | Denotes if the financial institution will be providing buyer/business(VCF)  data for the buyer. Valid Values are 'Y' and 'N'. | No |
| pseudoAccountsEnabled | boolean | Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it false.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank setting for this field.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this functionality. | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. Should be Numeric. Should be between 4 and 12 | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'.  The value can be set to true only if the bank is enabled for Online Payment Instructions. | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the buyer.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Requisitions. | No |

#### ErrorResponse-3 Schema

Error Response Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorItems | [ { **"errorCode"**: string, **"errorDescription"**: string } ] | list of errored items | No |

#### ErrorResponse-1 Schema

Error Response Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorItems | [ { **"errorCode"**: string, **"errorDescription"**: string } ] | list of errored items | No |

#### PaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expirationDays | string | Default payment expiration days which will be used if the buyer did not provide the payment expiration date either in the payment or has not configured for the supplier.  The payment expiration days will be used to calculate the payment expiration date (payment process date + the payment expiration days) which is the last day by which the supplier should collect the payment. Only numbers are allowed. If the parameter is not provided, system default this value to 30. | No |
| billingCurrency | string | Denotes the ISO alpha currency code associated with the billing Currency of the card accounts belonging to the buyer. All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. VPA system uses the billing currency as the payment currency for adjustable limit card accounts. | Yes |
| allowableCurrencies | [ string ] | The list of currencies allowed for the buyer.  The buyer can process payments in any of these currencies.  Any payments made other than these currencies will be rejected.  All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. Can setup up to a max of 200 currencies. Billing currency should be present in the list else the system will automatically add it to the list. Defaults to the billing currency if not provided. | No |
| paymentAdviceOption | string | Denotes if all payments to the same supplier in the same payment file will be consolidated and sent in one payment advice notification. Valid values are 'C' for consolidated or 'S' for split. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'C'. | No |
| expirationBufferDays | string | expirationBufferDays is the number of days after the payment expiration date by which the supplier needs to complete the collection of the payment (settlement of the card transaction should be completed). Only numbers are allowed. If the parameter is not provided, system default this value to 5. | No |
| securityCodeRequired | boolean | Denotes if security code is needed for the supplier to collect the payment. Valid values are 'True' or 'False'. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to the value set for the bank for this field.  This field can be set to true only if the bank security code (CVV2) option is set to  'True'. | No |

#### ReconciliationFileConfigForGet-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the recon file outbound. | No |
| fileFormat | integer | Denotes the format in which the recon file needs to be generated.   Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| deliveryTime | string | Denotes the delivery type or day when the recon file needs to be generated and delivered. Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| templateName | string | Denotes the name of the recon template to be used for generating the reconciliation file. | No |
| deliveryFrequency | integer | Denotes the frequency in which the recon file needs to be delivered.  Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the recon file in their VOL mailbox. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the buyer.  Valid Values are 'True' and 'False'. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the buyers.     Valid Values are 'True' and 'False'. | No |

#### AccountStatusResponse Schema

Top-level response for the Account Status Management API.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Echo of the messageId sent in the request. | No |
| responses | [ { **"responseCode"**: string, **"responseDescription"**: string } ] | Collection of overall status codes and descriptions for the request. Contains a single entry indicating overall success, partial success, or failure. | No |
| accountResults | [ { **"errorCode"**: string, **"updatedAt"**: string, **"lockStatus"**: string, <br>**Available values:** "L", "U", **"updateReason"**: string, **"accountNumber"**: string, **"errorDescription"**: string } ] | Per-account processing results. Only present when one or more accounts were successfully actioned or encountered a per-account error. Omitted when the response array alone describes the failure (e.g. schema validation failure). | No |

#### AdditionalParameter Schema

Name/value pair carrying one additional virtual account setting.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| parameterName | string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId" | Name of the parameter. For virtualAccountType '3' (VPP), valid keys are: 'fcsBankId' (required), 'admClientId' (required), 'processingType' (required), 'visaADMOptionId' and 'mcADMOptionId' (at least one of the two is required).<br>*Enum:* `"fcsBankId"`, `"admClientId"`, `"processingType"`, `"visaADMOptionId"`, `"mcADMOptionId"` | Yes |
| parameterValue | string | Value of the parameter. Must contain only alphanumeric characters and underscores. Maximum length is 50 characters. | Yes |

#### CardEligibilityRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier for the request message<br>*Example:* `"123456781234123412341234567890AB"` | Yes |
| accountNumber | string | Card account for eligibility determination; must be exactly 16 digits and pass Luhn (Mod 10) validation<br>*Example:* `"4111111111111111"` | Yes |
| billingaddress | { **"street"**: string, **"postalCode"**: string } | Address information for billing address validation | Yes |
| cardExpiryDate | string | The expiry date of the card in the format yyyy-mm<br>*Example:* `"2025-10"` | Yes |

#### ContactInfoForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | Contains the City Name of the buyer's contact address. This field can be updated at any time. | No |
| state | string | Contains the state of the buyer's contact address. This field can be updated at any time. | No |
| phone1 | string | Contains the buyer contact phone number 1. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces).  This field can be updated at any time. | No |
| phone2 | string | Contains the buyer contact phone number 2. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces).  This field can be updated at any time. | No |
| phone3 | string | Contains the buyer contact phone number 3. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces).  This field can be updated at any time. | No |
| buyerId | string | Contains the buyer identifier as defined in Visa Payables Automation. This is often the ID defined at the processor. Value format is 0–9.  This field is mandatory and needs to be sent to identify the buyer.  This field cannot be updated. | Yes |
| zipCode | string | Optional. Contains the Postal Code of the buyer's contact address.  Do not include special characters, e.g. hyphen, in the zipcode.  If a special character is provided it will be removed and processed with only nine digits. Null is allowed. | No |
| phone1Ext | string | Contains the extension of the buyer contact phone number 1. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces).  This field can be updated at any time. | No |
| phone2Ext | string | Contains the extension of the buyer contact phone number 2. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces).  This field can be updated at any time. | No |
| phone3Ext | string | Contains the extension of the buyer contact phone number 3. Field is alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces).  This field can be updated at any time. | No |
| contactName | string | Contains the name of the primary contact person in the buyer. Field is alphanumeric.  This field can be updated at any time. | No |
| countryCode | string | Contains the ISO alpha country code of the buyer's contact address. For example- USA. This field can be updated at any time. | No |
| addressLine1 | string | Contains the line 1 of the buyer's contact address.  This field can be updated at any time. | No |
| addressLine2 | string | Contains the line 2 of the buyer's contact address.  This field can be updated at any time. | No |
| addressLine3 | string | Contains the line 3 of the buyer's contact address.  This field can be updated at any time. | No |
| emailAddress | string | Contains the buyer's contact Email Address.  Should be a valid email address.  This field will be updated only if VPC is not enabled.  If VPC is enabled, this field can be updated only if there are no accounts setup for the buyer. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.  Select 1 if buyer will use VPA user interface  (issuer direct use of VPA).  Select 2 if buyer is created by a third party fintech and will use the VPA APIs.  Select 3 if buyer is created in VPA for Visa Commercial Pay service. | No |

#### AddressDTO Schema

Address information for billing address validation

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| street | string | Street address<br>*Example:* `"123"` | No |
| postalCode | string | Postal code or ZIP code<br>*Example:* `"12345"` | Yes |

#### Payment Schema

Payment Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| invoices | [ { **"invoiceDate"**: string, **"invoiceAmount"**: string, **"invoiceNumber"**: string, **"purchaseOrderDate"**: string, **"purchaseOrderNumber"**: string } ] | This complex element contains the details about the invoice associated with the payment. | No |
| supplier | { **"emailNotes"**: string, **"supplierID"**: string, **"supplierCity"**: string, **"supplierName"**: string, **"supplierState"**: string, **"supplierPostalCode"**: string, **"primaryEmailAddress"**: string, **"supplierCountryCode"**: string, **"supplierAddressLine1"**: string, **"supplierAddressLine2"**: string, **"alternateEmailAddresses"**: [ { **"alternateEmailAddress"**: string } ] } | Supplier Class | No |
| accountType | string | Account Type.  Valid values are-<br>      1- Lodged Adjustable Limit account  <br>    2- Lodged account.  <br>     Note-  This field is required only if the account is a new account which is not already lodged to the supplier for which the payment is made. | No |
| paymentType | string | Payment type.  Valid values are <br>  CCC - Credit Card Payment <br>  STP - Straight Through Processing payment | No |
| accountLimit | string | Credit limit of the account. <br>   Note-  This field is required only if the account is a new account which is not already lodged to the supplier for which the payment is made. | No |
| currencyCode | string | Payment Currency Code.  A valid ISO alpha currency code should be passed.  If the currency passed is not one of the supported currencies setup in the buyer profile, the payment will be rejected. | Yes |
| accountNumber | string | Account number can be an existing Visa account, a new account in the VPA system, or a proxy number. If this column is blank, the following logic is used for determining the account number <br>      1. Lodged account is used if there is one for the supplier.<br>      2. If the supplier does not have a lodged card account, system should  pick the card account from the pool based on the matrix in Account Picking logic table. | No |
| paymentExpiryDate | string | The date by which a supplier must collect a payment. Format is YYYY-MM-DD. | No |
| paymentGrossAmount | string | Payment gross amount.  Format is 99999999999999.99 | Yes |
| paymentRequestDate | string | Payment requested date.  If this field is blank, system will set the current date as the payment request date.Format is YYYY-MM-DD. | No |
| cardAccountExpiryDate | string | The expiry date for the card account | No |

#### GetProxyConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| holdDays | string | Denotes the number of days an account picked up for a payment in a proxy will be kept on hold before being used for another payment.  For payments, the hold days start from the day the payment was processed and for Request Virtual Account, the hold days start from the day the end date of the RVA has reached. | No |
| autoRefreshEnabled | boolean | Denotes if auto replenishment is enabled for proxies associated with the template (buyers). | No |
| bucketedProxyEnabled | boolean | Denotes if bucketed proxy is enabled for proxies associated with the template (buyers). | No |

#### StripePaymentConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stripePaymentEnabled | boolean | Denotes if Stripe payments is enabled for the buyer.  Valid values are 'True' or 'False'. This field can be set to true only if the bank Stripe Payment option is set to  'True'. You can enable Stripe payments for a buyer at any time.  But you cannot disable it (update it to false) if there are Stripe suppliers present for the buyer | No |
| remittanceNotificationEnabled | boolean | Denotes if the Stripe Payment Remittance notification is enabled for a buyer.  Optional field. Valid values are 'True' or 'False'. This field can be set to true only if the bank Stripe Payment Remittance Notification option is set to 'True'. The Stripe supplier will be getting the payment remittance notification only if this field is enabled. This field can be updated at any time. | No |

#### GetAuthorizationControlConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| alertsEnabled | boolean | Denotes if the system needs to send an alert when an authorization on a VPC enabled card is approved or declined. | No |
| issuerHoldingBID | string | Denotes the Holding BID (business id) for the issuer. | No |
| authControlEnabled | boolean | Denotes if the authorization controls needs to be enabled for the template (in turn the buyer).  Auth controls is mandated for VPP and VIP buyers. | No |

#### PaymentConfigForUpdate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expirationDays | string | Default payment expiration days which will be used if the buyer did not provide the payment expiration date either in the payment or has not configured for the supplier.  The payment expiration days will be used to calculate the payment expiration date (payment process date + the payment expiration days) which is the last day by which the supplier should collect the payment. Only numbers are allowed. This field can be updated at any time.  But the updates will affect only the future payments. | No |
| billingCurrency | string | Denotes the ISO alpha currency code associated with the billing Currency of the card accounts belonging to the buyer. All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. VPA system uses the billing currency as the payment currency for adjustable limit card accounts. This field can not be updated. | No |
| allowableCurrencies | [ string ] | The list of currencies allowed for the buyer.  The buyer can process payments in any of these currencies.  Any payments made usin other currencies will be rejected.  All ISO alpha currency codes will be supported. For example- USD for US Dollar. It should be one of the supported active currencies in VPA. Can setup up to a max of 200 currencies. Billing currency should be present in the list else the system will automatically add it to the list. This field can be updated at any time.  But the updates will affect only the future payments. | No |
| paymentAdviceOption | string | This option is used by the system decide if all payments to the same supplier should be consolidated or sent separately in the payment advice notificaion.  Valid values are 'C' for consolidated or 'S' for split. This field can be updated at any time. But the updates will affect only the future payments. | No |
| expirationBufferDays | string | expirationBufferDays is the number of days after the payment expiration date by which the supplier needs to complete the collection of the payment (settlement of the card transaction should be completed). Only numbers are allowed. This field can be updated at any time.  But the updates will affect only the future payments. | No |
| securityCodeRequired | boolean | Denotes if security code is needed for the supplier to collect the payment. Optional field. Valid values are 'True' or 'False'. This field can be set to true only if the bank security code (CVV2) option is set to  'True'. This field can be updated at any time. But the updates will affect only the future payments. | No |

#### AccountResult Schema

Per-account result indicating the outcome of the requested action on a single virtual account.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorCode | string | Per-account error code when this account could not be actioned. Only present on per-account failure. | No |
| updatedAt | string | Timestamp of the last status update on this account. Only present when the account was successfully processed. | No |
| lockStatus | string, <br>**Available values:** "L", "U" | Current lock status of the account after the operation. "L" = Locked; "U" = Unlocked. Only present when the account was successfully processed.<br>*Enum:* `"L"`, `"U"` | No |
| updateReason | string | The reason recorded for the last Lock or Unlock action. Only present when a reason was provided and the account was successfully processed. | No |
| accountNumber | string | The virtual account number that was processed. | No |
| errorDescription | string | Human-readable description of the per-account error. Only present on per-account failure. | No |

#### CreateBuyerSuccessResponse Schema

Response for successful creation of a Buyer

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| responseStatus | { **"status"**: string, <br>**Available values:** "success", "error", **"messageId"**: string, **"statusCode"**: string, **"statusDesc"**: string } | Default API Response | No |

#### PaymentSecurityConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customSecurityQuestions | [ string ] | The questions (text) which will be used at random (Only one of the questions will be displayed) to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. The system sends the security questions and answers to the supplier when the supplier is setup for the buyer. | No |
| defaultSecurityQuestion | string | Denotes the text for the default security question which will be displayed to the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. | No |
| defaultSecurityFieldCode | string | Denotes the field system uses to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. Valid values are '1' - Postal code and '2' - Supplier ID. I The default security is used only when the system creates new suppliers while processing payment files (EDI 820) or if custom security question is not enabled. | No |
| customSecurityQuestionsEnabled | boolean | Denotes if the buyer wants to use custom security questions to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  . | No |

#### UpdateBuyerTemplateRequest-1 Schema

Update Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | Denotes the client ID associated with the bank for which the template is being defined.  Should be alphanumeric and should exist in the system.  Visa will provide this during implementation.  This field cannot be updated. | Yes |
| messageId | string | Unique identifier for this request.  Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the CreateTemplate API. | Yes |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template.  Can be updated at any time. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| syncBuyerProfiles | boolean | - Valid values are True or False - If set to Y, all existing buyers associated with this template will adopt these changes. Updating existing buyers could disrupt payments in progress so before syncing profiles, ensure there will be no negative impacts to existing buyers. If set to N, changes will only be applied to future buyers created after the update Template API is sent. | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Supports AlphaNumeric characters. Can be updated at any time. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |

#### ProcessorConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| closeAccount | boolean | Denotes if the account needs to be closed at the processor.  For VIP Pseudo accounts, if this field is set to true, the pseudo account will be closed at the Visa Token System.  Valid Values are True or False. | No |

#### GetBuyerResponse-1 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } |  | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### PaymentSecurityConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customSecurityQuestions | [ string ] | The questions (text) which will be used at random (Only one of the questions will be displayed) to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. The system sends the security questions and answers to the supplier when the supplier is setup for the buyer.  At least one question needs to be sent if custom security question is enabled for the template. | No |
| defaultSecurityQuestion | string | Denotes the text for the default security question which will be displayed to the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  If the value for this field (the tag is not sent) is not provided, the system defaults it to "Credential Text". | No |
| defaultSecurityFieldCode | string | Denotes the field system uses to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. Valid values are '1' - Postal code and '2' - Supplier ID. If the value for this field (the tag is not sent) is not provided, the system defaults it to '1'. The default security is used only when the system creates new suppliers while processing payment files (EDI 820) or if custom security question is not enabled. | No |
| customSecurityQuestionsEnabled | boolean | Denotes if the buyer wants to use custom security questions to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  Valid values are 'True' and 'False'. Optional field. This field can be set to True only if the bank custom security questions option is set to True. | No |

#### GetBuyerTemplateRequest Schema

Get Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | ClientID associated with the bank. This will be provided by Visa at the time of setup. | Yes |
| messageId | string | Unique Identifier to identify the request. | Yes |
| templateId | string | Template ID is a unique identifier for a Template. It is system generated and will provided in the response of the CreateTEmplate API. | Yes |

#### GetBuyerResponse-2 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } |  | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### RvaReconciliationFileConfigForUpdate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the RVA recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. This field can be updated at any time. | No |
| commFileId | string | Denotes the Comm File ID associated with the RVA recon file outbound. The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound RVA recon file configuration has been completed. This field can be updated at any time. | No |
| fileFormat | integer | Denotes the format in which the RVA recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1. This field can be updated at any time. | No |
| templateId | string | Denotes the id of the recon template to be used for generating the RVA reconciliation file.  Valid values are 1 - RVA Recon standard template Version 1.0. This field can be updated at any time. | No |
| deliveryTime | string | Denotes the delivery type or day when the RVA recon file needs to be generated and delivered.    Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 This field can be updated at any time. | No |
| deliveryFrequency | integer | Denotes the frequency in which the RVA recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly. This field can be updated at any time. | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the RVA recon file in their VOL mailbox. You can setup upto 80 user ids to receive the RVA recon file.The user ids should have the VOL mailbox service entitled to them. This field can be updated at any time. | No |

#### GetWebServicesConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] |  | No |
| clientId | string | Denotes the client ID associated with the bank for which the template is being defined. Visa will provide this during implementation. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the template (Buyer). | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed.  If this field is set to true, then the web service consumers should handle the supplier communication themselves. | No |

#### UpdateBuyerTemplateRequest-2 Schema

Update Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | Denotes the client ID associated with the bank for which the template is being defined.  Should be alphanumeric and should exist in the system.  Visa will provide this during implementation.  This field cannot be updated. | Yes |
| messageId | string | Unique identifier for this request.  Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the CreateTemplate API. | Yes |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template.  Can be updated at any time. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| syncBuyerProfiles | boolean | - Valid values are True or False - If set to Y, all existing buyers associated with this template will adopt these changes. Updating existing buyers could disrupt payments in progress so before syncing profiles, ensure there will be no negative impacts to existing buyers. If set to N, changes will only be applied to future buyers created after the update Template API is sent. | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Supports AlphaNumeric characters. Can be updated at any time. | No |
| virtualAccountConfig | { **"virtualAccountType"**: string, **"additionalParameters"**: [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", **"parameterValue"**: string } ] } | Virtual account configuration for a buyer template. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |

#### OnboardingRequest Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| buyerId | string | Buyer ID is the buyer identifier as defined in Visa Payables Automation. Value format is 09. | Yes |
| issuerId | string | A '-' (hyphen) separated field which contains the region id, processor id and bank id | Yes |
| messageId | string | Unique identifier for the message | Yes |
| accountingSoftware | string | Name of the accounting software | Yes |

#### UpdateBuyerTemplateRequest-3 Schema

Update Buyer Template Request

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | Denotes the client ID associated with the bank for which the template is being defined.  Should be alphanumeric and should exist in the system.  Visa will provide this during implementation.  This field cannot be updated. | Yes |
| messageId | string | Unique identifier for this request.  Each request sent to VPA requires its own unique ID. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean } |  | No |
| templateId | string | Unique Identifier for a Template. It should be alphanumeric.  Should be an existing template id associated with the bank (associated to the client id).  The template id is returned in the response of the CreateTemplate API. | Yes |
| contactInfo | { **"phone1"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| templateName | string | Name of the template.  Can be updated at any time. Alphanumeric. No special characters other than _ - * & ' ! , . '#' and – (Dash) are allowed. It has to be unique within a Bank. | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"closeAccount"**: boolean } |  | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| syncBuyerProfiles | boolean | - Valid values are True or False - If set to Y, all existing buyers associated with this template will adopt these changes. Updating existing buyers could disrupt payments in progress so before syncing profiles, ensure there will be no negative impacts to existing buyers. If set to N, changes will only be applied to future buyers created after the update Template API is sent. | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"vcfDataFeedIndicator"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| templateDescription | string | Supports AlphaNumeric characters. Can be updated at any time. | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string ] } | Parent tag which contains the approval workflow configurations. | No |
| reconciliationFileConfig | { **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceFileDetails"**: boolean, **"supplierReminderNotificationDays"**: string, **"supplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean } |  | No |

#### PaymentConfigForGet Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| expirationDays | string | Default payment expiration days which will be used if the buyer did not provide the payment expiration date either in the payment or has not configured for the supplier.  The payment expiration days will be used to calculate the payment expiration date (payment process date + the payment expiration days) which is the last day by which the supplier should collect the payment. | No |
| billingCurrency | string | Denotes the ISO alpha currency code associated with the billing Currency of the card accounts belonging to the buyer. All ISO alpha currency codes will be supported. For example- USD for US Dollar. VPA system uses the billing currency as the payment currency for adjustable limit card accounts. | No |
| allowableCurrencies | [ string ] | The list of currencies allowed for the buyer.  The buyer can process payments in any of these currencies.  Any payments made using any other currencies will be rejected.  All ISO alpha currency codes will be supported. For example- USD for US Dollar. | No |
| defaultSecurityCode | boolean | Denotes if the security code needs to be enabled by default for all the new suppliers created.<br>**Read-only** | No |
| paymentAdviceOption | string | This option is used by the system to decide if all payments to the same supplier should be consolidated or sent separately in the payment advice notificaion. | No |
| expirationBufferDays | string | expirationBufferDays is the number of days after the payment expiration date by which the supplier needs to complete the collection of the payment (settlement of the card transaction should be completed). | No |
| securityCodeRequired | boolean | Denotes if security code is needed for the supplier to collect the payment. | No |

#### GetPaymentNotificationConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| dateFormat | string | Denotes the date format which will be used for parsing date fields in the payment files in EDI or CVV tab format. | No |
| defaultBuyerLanguageCode | string | Denotes the language (Locale like for e.g. en_US for US english ) which will be used in notifications sent to the buyer. | No |
| attachRemittanceFileDetails | boolean | Denotes if the remittance details file (containing the invoice details) will be attached to the payment advice notification while processig a payment. | No |
| supplierReminderNotificationDays | string | Denotes the number of days before the payment expiration date when the system sends a reminder notification to the supplier. | No |
| supplierReminderNotificationEnabled | boolean | Denotes if the system will send the payment reminder notification to the supplier (before the configured number of days (supplier reminder notification days) from the payment expiration date) to remind them to collect the payment. | No |

#### GetBuyerResponse-3 Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } | Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility. | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### ResendPaymentRequest Schema

Resend payment request payload

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| buyerId | string | Buyer ID is the buyer identifier as defined in Visa Payables Automation. Value format is 09. | Yes |
| issuerId | string | A '-' (hyphen) separated field which contains the region id, processor id and bank id | Yes |
| vendorId | string | Identifier used by the buyer to identify the vendor. This is the vendor id of the vendor whose payment is being modified. | Yes |
| clientKey | string | Client key for secure communication | No |
| messageId | string | Unique ID specific to this API call. | Yes |
| emailNotes | string | Extra notes for the email address | No |
| accountNumber | string | An existing Visa card account. Values are 09. Note- If the account number is passed, it should correspond to the card account number used for the payment. | No |
| codeChallenge | string | Code Challenge for secure communication | No |
| expirationDate | string | The date by which a supplier must collect his payment. Format is YYYY-MM-DD | No |
| primaryEmailAddress | string | This contains the email address for the supplier that will receive the payment instruction. It must be a valid email address. If the primary email address is provided, the payment advice will be sent to the new primary email address provided in the request. If it is not, the email address in the original request will be used. | No |
| alternateEmailAddresses | [ { **"alternateEmailAddress"**: string } ] | This complex element will contain up to five alternate email addresses. | No |
| accountingSoftwareEntityId | string | Unique ID used by that particular accounting software entity<br>*Example:* `"bill Id with respect to QuickBooks Online(QBO)"` | Yes |
| supplierProfileUpdateIndicator | string | This field contains value as Y if supplier profile has to be updated and N if supplier profile should not be updated. By default, the system will not update the supplier profile with the new values sent in the request. | No |

#### RVAReconciliationFileConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| commFileId | string | Comm file Id refers to Comm File info associated with the Request Virtual Account recon file outbound delivery. Required if RVAReconFileDelivery is set to Comms | No |
| templateId | string | Denotes the template identifier associated with the RVA recon template to be used for generating the RVA recon file. | No |

#### UpdateApprovalWorkflowConfig Schema

Parent tag which contains the approval workflow configurations.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| workflowConfigEnabled | boolean | Denotes if the Approval Workflow is enabled for the template (Buyer).  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option.  This field can be edited only if the sync Buyer Profiles is set to false. | No |
| workflowFunctionCodes | [ string ] |  | No |

#### StripePaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stripePaymentEnabled | boolean | Denotes if Stripe payments is enabled for the template (buyer).  Valid values are 'True' or 'False'. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'.  This field can be set to true only if the bank Stripe Payment option is set to  'True'. | No |
| remittanceNotificationEnabled | boolean | Denotes if the Stripe Payment Remittance notification is enabled for a template (buyer).  Valid values are 'True' or 'False'. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'.  This field can be set to true only if the bank Stripe Payment Remittance Notification option is set to 'True'. Only if this field is enabled, the Stripe supplier will be getting the payment remittance notification. | No |

#### ProcessorConfigForCreate Schema

This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| processorFields | object |  | No |
| closeAccountEnabled | boolean | Default to Yes if processor integration is enabled for the bank. Default to N if Processor integration is not enabled for the bank. Default to Y if the buyer is enabled for VIP/VPP tokens. | No |

#### VanConfig-1 Schema

Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank FCS ID if there is only one setup at the bank level. Supports alphanumeric values. Required if the template is enabled for VANs. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the template (buyers). Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |

#### PaymentSecurityConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| customSecurityQuestions | [ string ] | The questions (text) which will be used at random (Only one of the questions will be displayed) to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. The system sends the security questions and answers to the supplier when the supplier is setup for the buyer.  At least one question needs to be sent if custom security question is enabled for the buyer. | No |
| defaultSecurityQuestion | string | Denotes the text for the default security question which will be displayed to the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  If the value for this field (the tag is not sent) is not provided, the system defaults it to "Credential Text". | No |
| defaultSecurityFieldCode | string | Denotes the field system uses to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details. Valid values are '1' - Postal code and '2' - Supplier ID. If the value for this field (the tag is not sent) is not provided, the system defaults it to '1'. The default security is used only when the system creates new suppliers while processing payment files (EDI 820) or if custom security question is not enabled. | No |
| customSecurityQuestionsEnabled | boolean | Denotes if the buyer wants to use custom security questions to authenticate the supplier when they click on the URL sent in the payment advice notification for viewing the full card details.  Valid values are 'True' and 'False'. Optional field. This field can be set to True only if the bank custom security questions option is set to True. | No |

#### GetBuyerResponse Schema

Get Buyer Response Class

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| vanConfig | { **"fcsBankId"**: string, **"vanEnabled"**: boolean, **"aceClientId"**: string, **"admClientId"**: string, **"mcADMOptionId"**: string, **"processingType"**: string, **"visaADMOptionId"**: string, **"settlementExpirationDays"**: integer } |  | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | Yes |
| statusDesc | string | Status description of the response. | Yes |
| contactInfo | { **"city"**: string, **"state"**: string, **"phone1"**: string, **"phone2"**: string, **"phone3"**: string, **"buyerId"**: string, **"zipCode"**: string, **"buyerName"**: string, **"companyId"**: string, **"phone1Ext"**: string, **"phone2Ext"**: string, **"phone3Ext"**: string, **"templateId"**: string, **"contactName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string, **"emailAddress"**: string, **"implementationType"**: integer } |  | No |
| proxyConfig | { **"holdDays"**: string, **"autoRefreshEnabled"**: boolean, **"bucketedProxyEnabled"**: boolean } |  | No |
| billingConfig | { **"billingBID"**: string, **"billingType"**: string } |  | No |
| paymentConfig | { **"expirationDays"**: string, **"billingCurrency"**: string, **"allowableCurrencies"**: [ string ], **"defaultSecurityCode"**: boolean, **"paymentAdviceOption"**: string, **"expirationBufferDays"**: string, **"securityCodeRequired"**: boolean } |  | No |
| processorConfig | { **"embossedLine2"**: string, **"processorFields"**: object, **"suaEmbossedLine1"**: string, **"closeAccountEnabled"**: boolean, **"lodgedEmbossedLine1"**: string } | This section is used if the issuer has processor integration enabled.  When using processor PANs, the following processors can be enabled for processor integration: FIS, FDR, TS1, TS2, and TSUK.    When using Visa Pseudo accounts or TSYS VANs, processor integration is not required but if it is enabled the system goes to the processor to retrieve the latest values (such as expiry date, current balance and available balance for the funding accounts).  The fields vary for each processor so refer to the details <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details"> Buyer Setup Details </a> page for more information on which fields are required for each processor. If using TSYS VPP VANs or Visa VIP Pseudo Accounts, defaults values can be used.  Please refer to the Buyer Setup Details page for the defaults | No |
| stpPaymentConfig | { **"stpPaymentEnabled"**: boolean, **"accountHolderLastName"**: string, **"accountHolderFirstName"**: string, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentFileConfig | { **"edi824FileId"**: string, **"edi997FileId"**: string, **"inboundFileId"**: string } |  | No |
| webServicesConfig | { **"apiCodes"**: [ string ], **"clientId"**: string, **"vbdsClientId"**: string, **"webServicesEnabled"**: boolean, **"suppressSupplierNotification"**: boolean } |  | No |
| boostPaymentConfig | { **"boostPaymentEnabled"**: boolean } |  | No |
| buyerFeatureConfig | { **"cardMaskingDigits"**: string, **"pseudoAccountsEnabled"**: boolean, **"fullAccountViewEnabled"**: boolean, **"cardMaskingDigitsOnline"**: string, **"onlinePaymentInstructionEnabled"**: boolean, **"onlinePaymentRequisitionEnabled"**: boolean } |  | No |
| responseFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |
| stripePaymentConfig | { **"stripePaymentEnabled"**: boolean, **"remittanceNotificationEnabled"**: boolean } |  | No |
| paymentSecurityConfig | { **"customSecurityQuestions"**: [ string ], **"defaultSecurityQuestion"**: string, **"defaultSecurityFieldCode"**: string, **"customSecurityQuestionsEnabled"**: boolean } |  | No |
| approvalWorkflowConfig | { **"workflowConfigEnabled"**: boolean, **"workflowFunctionCodes"**: [ string, <br>**Available values:** "AUCL", "LCRC", "PYIN", "PYRN" ] } |  | No |
| reconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"deliveryTime"**: string, **"templateName"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ], **"adhocReconciliationReportEnabled"**: boolean, **"onlinePaymentReconciliationEnabled"**: boolean } |  | No |
| paymentNotificationConfig | { **"dateFormat"**: date, **"settlementSource"**: string, **"paymentAdviceTemplate"**: string, **"defaultBuyerLanguageCode"**: string, **"attachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationDays"**: string, **"defaultAttachRemittanceDetailsFile"**: boolean, **"supplierReminderNotificationEnabled"**: boolean, **"defaultSupplierReminderNotificationEnabled"**: boolean } |  | No |
| authorizationControlConfig | { **"alertsEnabled"**: boolean, **"issuerHoldingBID"**: string, **"authControlEnabled"**: boolean, **"defaultAuthControlEnabled"**: boolean, **"authControlPaymentTemplate"**: string } |  | No |
| rvaReconciliationFileConfig | { **"fileLevel"**: string, **"commFileId"**: string, **"fileFormat"**: integer, **"templateId"**: string, **"deliveryTime"**: string, **"deliveryFrequency"**: integer, **"recipientLoginIds"**: [ string ] } |  | No |

#### Error Schema

Error object

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| errorList | [ { **"errorCode"**: string, **"errorDescription"**: string } ] |  | No |

#### STPPaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stpPaymentEnabled | boolean | Denotes if the STP Payments is enabled for a template (buyer). Valid values are 'True' or 'False'. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'.  This field can be set to true only if the bank STP Payments option is set to  'True'. | No |
| remittanceNotificationEnabled | boolean | Denotes if the STP Payment Remittance notification is enabled for a template (buyer). Valid values are 'True' or 'False'. Optional field. If the value for this field (the tag is not sent) is not provided, the system defaults it to 'False'.  This field can be set to true only if the bank STP Payment Remittance Notification option is set to 'True'. Only if this field is enabled, the STP supplier will be getting the payment remittance notification. | No |

#### GetStripePaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stripePaymentEnabled | boolean | Denotes if Stripe payments is enabled for the template (buyer). | No |
| remittanceNotificationEnabled | boolean | Denotes if the Stripe Payment Remittance notification is enabled for a template (buyer). | No |

#### GetPaymentDetailsResponse Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| payments | { **"invoices"**: [ { **"invoiceDate"**: string, **"invoiceAmount"**: integer, **"invoiceNumber"**: string, **"purchaseOrderDate"**: string, **"purchaseOrderNumber"**: string, **"partialPaymentIndicator"**: string } ], **"supplier"**: { **"supplierID"**: string, **"supplierName"**: string, **"primaryEmailAddress"**: string, **"alternateEmailAddresses"**: [ { **"localAlternateEmailAddress"**: string } ] }, **"paymentType"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"manualMatchStatus"**: string, **"paymentExpiryDate"**: string, **"systemMatchStatus"**: string, **"paymentDescription"**: string, **"paymentGrossAmount"**: string, **"paymentRequestDate"**: string } |  | No |
| messageId | string |  | No |
| statusCode | string |  | No |
| statusDesc | string |  | No |
| resultSetNo | string |  | No |
| hasMoreElements | string |  | No |
| totalRecordCount | string |  | No |

#### ProxyConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| holdDays | string | Denotes the number of days an account picked up for a payment in a proxy will be kept on hold before being used for another payment.  For payments, the hold days start from the day the payment was processed and for Request Virtual Account, the hold days start from the day the end date of the RVA has reached. Should be a numeric value between 1 to 999. If the value for this field (the tag is not sent) is not provided, the system defaults it to 90 days. | No |
| autoRefreshEnabled | boolean | Denotes if auto replenishment is enabled for proxies associated with the template (buyers).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it to False for memo account buyers and to true for VIP and VPP enabled buyers.   The value of this field should be set to true for VIP and VPP enabled buyers.   The value can be set to true only if the bank is enabled for auto replenishment. | No |
| bucketedProxyEnabled | boolean | Denotes if bucketed proxy is enabled for proxies associated with the template (buyers). Valid Values are 'True' and 'False'.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   The value can be set to true only if the bank is enabled for bucketed proxy. | No |

#### GetBuyerFeatureConfigV2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| cardMaskingDigits | string | Denotes the number of digits that will be masked for the card number when displayed in all places other than UI like the recon file, response file, etc. | No |
| vcfDataFeedIndicator | string | The vcfDataFeedIndicator is used for indicating the source of transactions/settlement data for this company. This value should be “Yes” if the FI/Processor is going to send settled transactions for the company [e.g. inbound Visa Commercial Format (VCF)]. It should be “No” if the company requires Visa to pull the settlement data over the Visa Network.   | No |
| pseudoAccountsEnabled | boolean | Superseded by virtualAccountConfig. Still supported for backward compatibility. Denotes if "Pseudo Accounts" (VIP Tokens) option is enabled for the template (buyers). If virtualAccountConfig.virtualAccountType is provided, it determines the effective virtual account type, and this field is automatically set to match it (rather than being independently honored). If virtualAccountConfig is omitted, this field's value is used instead to derive the virtual account type. | No |
| fullAccountViewEnabled | boolean | Denotes if "Full Account View" functionality is enabled for the template (buyers). | No |
| cardMaskingDigitsOnline | string | Denotes the number of digits that will be masked for the card number when displayed in the UI. | No |
| onlinePaymentInstructionEnabled | boolean | Denotes if Online payment instruction (Pay Now) functionality is enabled for the template (buyers). | No |
| onlinePaymentRequisitionEnabled | boolean | Denotes if Online payment Requisition functionality is enabled for the template (buyer). | No |

#### ReconciliationFileConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company. | No |
| commFileId | string | Denotes the Comm File ID associated with the recon file outbound. Required if the file level is B. The Visa implementation team provides this value after the outbound recon file configuration has been completed. | No |
| fileFormat | integer | Denotes the format in which the recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1 | No |
| deliveryTime | string | Denotes the delivery type or day when the recon file needs to be generated and delivered. If the value for this field (the tag is not sent) is not provided, the system defaults it to'1:00' AM for the daily frequency and 2 for weekly and 1 for monthly frequency.   Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31 | No |
| templateName | string | Denotes the name of the recon template to be used for generating the reconciliation file. If the value for this field (the tag is not sent) is not provided, the system defaults it to the latest recon standard template. | No |
| deliveryFrequency | integer | Denotes the frequency in which the recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the recon file in their VOL mailbox. You can setup upto 50 user ids to receive the recon file. The user ids should have the VOL mailbox service entitled to them. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the buyer. If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Adhoc Reconciliation. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the buyers.  If the value for this field (the tag is not sent) is not provided, the system defaults it to False.   Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Reconciliation. | No |

#### VanConfigForGet-1 Schema

Deprecated — superseded by virtualAccountConfig. Still supported for backward compatibility.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fcsBankId | string | Denotes the Bank Identifier in the TSYS VPP FCS system.  If the value for this field (the tag is not sent) is not provided, the system defaults it to the bank FCS ID if there is only one setup at the bank level. Supports alphanumeric values. Required if the buyer is enabled for VANs. | No |
| vanEnabled | boolean | Denotes if "VANs" (VPP Tokens) are enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for this Option. | No |
| aceClientId | string | Denotes the  number used to identify the bank on the Tsys ACE Decision Max system for account assignment.<br>**Read-only** | No |
| admClientId | string | Denotes the number the TSYS VPP system uses to identify the company on the ACE Decision Max system for account assignment. | No |
| mcADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. This field will be populated only if it is a Mastercard Bank. | No |
| processingType | string | Denotes the Processing type for the virtual account number (VAN). | No |
| visaADMOptionId | string | Denotes the option that will be used to assign the virtual account number in the TSYS VPP platform. For the TS1 platform only, the option must be set up to assign a virtual account number from the same BIN as the primary account number. This field will be populated only if it is a Visa Bank. | No |
| settlementExpirationDays | integer | Denotes the number of days after which settlement will not be honored on the virtual account (VAN).<br>**Read-only** | No |

#### Response Schema

Default API Response

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string, <br>**Available values:** "success", "error" | Response status `success` or `error`<br>*Enum:* `"success"`, `"error"` | No |
| messageId | string | Unique identifier for identifying the request. | No |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table below. | No |
| statusDesc | string | Status description of the response. | No |

#### ContactInfo-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| phone1 | string | Buyer contact phone number. Should be alphanumeric. Special characters allowed are - (dash), ( (Open braces),) (close braces). | No |
| emailAddress | string | Denotes the buyer's contact Email Address.  Should be an valid email address. | No |
| implementationType | integer | Valid Values are:1 – VPA UI, 2 – VPA API and 3 – Visa Commercial Pay.1 denotes buyer uses VPA UI (issuer direct use of VPA).  2 denotes buyer uses a third party fintech's user interface and third party is using VPA APIs. 3 denotes buyer uses Visa Commercial Pay service. | No |

#### ReconciliationFileConfigForUpdate-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fileLevel | string | Denotes if the recon COMM File configuration is defined to be delivered to the bank(B) or Company (C).  Valid values are B - Bank and C - Company.  This field can be updated at any time. | No |
| commFileId | string | Denotes the Comm File ID associated with the recon file outbound.  The COMM file definition should exist in the system.  The Visa implementation team provides this value after the outbound recon file configuration has been completed. This field can be updated at any time. | No |
| fileFormat | integer | Denotes the format in which the recon file needs to be generated. Needs to be numeric. Valid values are 1 – XLS V0, 2 – CSV V0, 3 -  XLS V1, 4 – CSV V1.   This field can be updated at any time. | No |
| deliveryTime | string | Denotes the delivery type or day when the recon file needs to be generated and delivered. If the value for this field (the tag is not sent) is not provided, the system defaults it to'1:00' AM for the daily frequency and 1 for weekly and monthly frequency.   Valid format for the time for the daily frequency is 'HH:MM' in 24 hours format.  Valid values for the Weekly frequency  1 to 7 denoting the days.  1 being Sunday and 7 being Saturday and Monthly Frequency 1 to 31. This field can be updated at any time. | No |
| templateName | string | Denotes the name of the recon template to be used for generating the reconciliation file.  This field can be updated at any time. | No |
| deliveryFrequency | integer | Denotes the frequency in which the recon file needs to be delivered. Needs to be numeric. Valid values are 1 – Daily 2 – Weekly 3 - Monthly. This field can be updated at any time. | No |
| recipientLoginIds | [ string ] | Contains the list of user ids of bank/buyer users who will be receiving the recon file in their VOL mailbox. You can setup upto 80 user ids to receive the recon file. The user ids should have the VOL mailbox service entitled to them.This field can be updated at any time. | No |
| adhocReconciliationReportEnabled | boolean | Denotes if Adhoc Reconciliation functionality is enabled for the buyer. Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Adhoc Reconciliation.  This field can be updated at any time. | No |
| onlinePaymentReconciliationEnabled | boolean | Denotes if Online payment Reconciliation functionality is enabled for the buyers.  Valid Values are 'True' and 'False'. The value can be set to true only if the bank is enabled for Online Payment Reconciliation.  This field can be updated at any time. | No |

#### PaymentFileCommConfigForCreate Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| edi824FileId | string | Denotes the Comm File ID associated with the EDI 824 outbound response file.  The COMM file definition should exist in the system.  The Visa implementation team provides this value after the inbound file configuration has been completed. | No |
| edi997FileId | string | Denotes the Comm File ID associated with the EDI 997 outbound ack file. The COMM file definition should exist in the system.  The Visa implementation team provides this value after the inbound file configuration has been completed. | No |
| inboundFileId | string | Denotes the Comm file ID associated with the inbound payment file (EDI 820 or SFF). The COMM file definition should exist in the system.  The Visa implementation team provides this value after the inbound file configuration has been completed. | No |

#### VirtualAccountConfigForUpdate Schema

Virtual account configuration supplied when updating a buyer.

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| virtualAccountType | string | Virtual account type for the buyer. Valid values are '1' (processor PANs), '2' (VIP token), '3' (VPP token) and '4' (visa-virtual-card). No other value is accepted. | Yes |
| additionalParameters | [ { **"parameterName"**: string, <br>**Available values:** "fcsBankId", "admClientId", "processingType", "visaADMOptionId", "mcADMOptionId", **"parameterValue"**: string } ] | Additional parameters for the virtual account configuration. Required for virtualAccountType '3' (VPP): 'fcsBankId', 'admClientId' and 'processingType' are always required, and at least one of 'visaADMOptionId' or 'mcADMOptionId' is also required. Not required for virtualAccountType '2' (VIP) or '4' (visa-virtual-card). | No |

#### WebServicesConfig-1 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] |  | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the template (Buyer).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it false.   The value can be set to true only if the bank is enabled for this Option. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed. Valid Values are 'True' or 'False'. If this field is set to true, then the web service consumers should handle the supplier communication themselves.   If the value for this field (the tag is not sent) is not provided, the system defaults it to False. | No |

#### WebServicesConfig-2 Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| apiCodes | [ string ] |  | No |
| clientId | string | Reserved for Future use. The system will default the client ID to what is set for the bank. | No |
| vbdsClientId | string | vbdsClientId is the unique id generated for third parties wanting to subscribe for auth/settlement data in VBDS system. Should be numeric. | No |
| webServicesEnabled | boolean | Denotes if the web services is enabled for the template (Buyer).  Valid Values are 'True' and 'False'. If the value for this field (the tag is not sent) is not provided, the system defaults it false.   The value can be set to true only if the bank is enabled for this Option. | No |
| vbdsDataSubscription | [ { **"dataSubscriptionType"**: number, **"dataSubscriptionAccountType"**: [ { **"subscribed"**: boolean, **"accountType"**: string } ] } ] | This complex element captures information about the subscription to Data APIs. This is optional and if this object is not provided, the subscription defaults to bank configuration for the given vbdsClientId. | No |
| suppressSupplierNotification | boolean | Denotes if all supplier notifications needs to be suppressed. Valid Values are 'True' or 'False'. If this field is set to true, then the web service consumers should handle the supplier communication themselves.   If the value for this field (the tag is not sent) is not provided, the system defaults it to False. | No |

#### GetSTPPaymentConfig Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| stpPaymentEnabled | boolean | Denotes if the STP Payments is enabled for a template (buyer). | No |
| remittanceNotificationEnabled | boolean | Denotes if the STP Payment Remittance notification is enabled for a template (buyer). | No |

#### ResendPaymentErrorResponse Schema

Error Codes

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RSP001 | object | Resend Payment initiated successfully. | No |
| RSP003 | object | Invalid Client ID. | No |
| RSP004 | object | Invalid buyer ID. | No |
| RSP005 | object | Invalid account number. | No |
| RSP012 | object | Invalid primary email address. | No |
| RSP013 | object | Invalid alternate email address. | No |
| RSP025 | object | Bank is not subscribed. | No |
| RSP029 | object | Original message ID and account number do not match. | No |
| RSP030 | object | Original message ID does not exist. | No |
| RSP035 | object | Invalid message ID. | No |
| RSP043 | object | Invalid original message ID. | No |
| RSP049 | object | ExpirationDate is invalid. Supported date format is YYYY-MM-DD. | No |
| RSP161 | object | Payment has already expired. | No |
| RSP162 | object | SupplierProfileUpdateIndicator is invalid. | No |
| RSP163 | object | PrimaryEmailAddress is required. | No |
| RSP167 | object | Payment was not processed successfully or is in progress. | No |
| RSP173 | object | Invalid email notes. | No |
| RSP182 | object | Invalid alternate address tag. | No |
| RSP186 | object | Expiration Date is invalid. Expiration Date cannot be past date | No |
| RSP029a | object | Original message ID and account number do not match. | No |

#### ApiDetailList Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | Gives the current status of the POP application endpoints in OCC or OCE<br>*Example:* `"All services are up and running"` | Yes |
| overallStatus | string | Gives the status as UP or DOWN based on the services status for the 2 datacentres<br>*Example:* `"UP, DOWN"` | Yes |

#### ResendPaymentResponse Schema

Resend Payment Response Schema

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier which was sent in the request. | Yes |
| statusCode | string | Status code of the response. It is alphanumeric. The values are specific to each method. For the details of the various error codes returned for this method refer to the "Error Codes" table. | Yes |
| statusDesc | string | Status description of the response. | Yes |

#### CardEligibilityResponse Schema

Response object containing card eligibility information

| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| messageId | string | Unique identifier for the request message that references the original request<br>*Example:* `"123456781234123412341234567890AB"` | No |
| isEligible | boolean | Boolean flag indicating whether the card is eligible for the requested service<br>*Example:* `true` | No |
| statusCode | string | Status code indicating the result of the eligibility check<br>*Example:* `"CES000"` | No |
| statusDescription | string | User‑friendly status message<br>*Example:* `"Card is eligible"` | No |