B2B Virtual Account Payment Method is a digital payment solution designed for businesses to streamline their payment processes when dealing with suppliers or partners. This method allows businesses to create virtual accounts for each transaction, providing a secure and efficient way to transfer funds without the need for traditional banking methods.
---
openapi: 3.0.1
info:
title: B2B Virtual Account Payment Method
description: ''
version: '1'
servers:
- url: https://sandbox.api.visa.com
description: Sandbox server
security: []
tags:
- name: Account Management service
description: The Account Management web services are used to manage payment controls
for existing card accounts and to request virtual accounts while setting controls.
The endpoints allow the user to retrieve the status of new account requests, view
authorization rules, submit virtual card requisitions for an employee , and retrieve
security code (CVV2) details of an existing account.
- name: Buyer Management Service
description: The Buyer Service provides self-service capabilities that simplify
and reduce the implementation process for new VPA buyers (and other downstream
systems). Buyers can be created from scratch or from a pre-defined Buyer Template.
Either way, these APIs help streamline the process and increase the speed of buyer
deployments, as well as provide third parties with insight into the buyers configurations
for troubleshooting. For more details about the requirements for creating a buyer,
please reference the <a href="/pages/B2B-virtual-account-payment-method-codes#buyer_setup_details">Buyer
Setup Details</a> page.
- name: Payment Service
description: The Payment web service is used for processing payments and sending
payment remittance information to the appropriate suppliers.
- name: Single Use Account Pool Maintenance Service
description: The Proxy web service is used for managing a pool of Single-Use Accounts
(SUAs) linked to a proxy. With this web service, you can create proxy pool(s)
for a buyer, update details of the proxy, delete unused pools and get details
about an existing pool(e.g. number of available accounts).
- name: Supplier Service
description: The Supplier web service is used for creating and maintaining a supplier.
- name: Workflows
description: Workflows
paths:
"/vpa/v2/buyerManagement/buyerTemplate/get":
post:
tags:
- Buyer Management Service
summary: Get Buyer Template
description: Obtain all current parameters for an existing buyer template. Optional
and default values will be provided as well as the ability to obtain a full
picture of the buyer configurations. This is helpful for troubleshooting or
to see the details of a template before many any changes to it.
operationId: Get Buyer Template V2
requestBody:
description: Request Details for getting the details of a Buyer template.
content:
application/json:
schema:
"$ref": "#/components/schemas/GetBuyerTemplateRequest"
examples:
Default:
summary: Default
value:
clientId: B2BWS_1_Region_Bank_9999
messageId: '107970185555'
templateId: '1_3_9999_811'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
"$ref": "#/components/schemas/GetBuyerTemplateSuccessResponseV2"
examples:
Default:
summary: Default
value:
responseObject:
responseFileConfig:
proxyConfig:
holdDays: '30'
bucketedProxyEnabled: false
autoRefreshEnabled: true
boostPaymentConfig:
boostPaymentEnabled: false
contactInfo:
implementationType: 2
emailAddress: [email protected]
phone1: '99999977'
buyerFeatureConfig:
fullAccountViewEnabled: true
cardMaskingDigitsOnline: '12'
vcfDataFeedIndicator: Y
onlinePaymentInstructionEnabled: true
onlinePaymentRequisitionEnabled: true
cardMaskingDigits: '7'
pseudoAccountsEnabled: false
rvaReconciliationFileConfig:
billingConfig:
billingType: I
billingBID: '10048816840'
stripePaymentConfig:
remittanceNotificationEnabled: true
stripePaymentEnabled: true
vanConfig:
fcsBankId: F286
vanEnabled: true
stpPaymentConfig:
remittanceNotificationEnabled: true
stpPaymentEnabled: true
webServicesConfig:
apiCodes:
webServicesEnabled: false
clientId:
suppressSupplierNotification:
vbdsClientId:
templateId: '1_3_9999_811'
paymentConfig:
securityCodeRequired: true
allowableCurrencies:
- USD
expirationDays: '30'
billingCurrency: USD
expirationBufferDays: '5'
paymentAdviceOption: C
paymentFileCommConfig:
paymentSecurityConfig:
defaultSecurityFieldCode: '1'
defaultSecurityQuestion: Credential Text
customSecurityQuestions:
- What is Security answer?
- What is SSN Number?
customSecurityQuestionsEnabled: true
approvalWorkflowConfig:
workflowFunctionCodes:
- AUCL
- PYIN
workflowConfigEnabled: true
authorizationControlConfig:
issuerHoldingBID: '10000290'
authControlEnabled: true
alertsEnabled: true
paymentNotificationConfig:
defaultBuyerLanguageCode: en_US
supplierReminderNotificationDays: '12'
dateFormat: MMDDYYYY
supplierReminderNotificationEnabled: true
attachRemittanceFileDetails: true
templateName: VPP-APITemplate-vcfInd-Null23
templateDescription: VPP-APITemplate-vcfInd-Null23_Updated
reconciliationFileConfig:
adhocReconciliationReportEnabled: false
commFileId:
templateName:
onlinePaymentReconciliationEnabled: false
processorConfig:
closeAccount: true
responseStatus:
statusDesc: Buyer template details retrieved successfully.
messageId: '107970185555'
status: success
statusCode: BSGT0000
'400':
description: Refer to the <a href="/pages/B2B-virtual-account-payment-method-error-codes#get_buyer_template">Error
Codes</a> page for the list of error codes for this API.
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
x-samplePayload: ''
x-codegen-request-body-name: templateRequest
x-operationVersions:
- label: v1
operationPointer: "#/paths/~1vpa~1v1~1buyerManagement~1buyerTemplate~1get/post"
default: false
- label: v2 - Latest
operationPointer: "#/paths/~1vpa~1v2~1buyerManagement~1buyerTemplate~1get/post"
default: false
x-hideTryIt: true
"/vpa/v1/buyerManagement/buyer/get":
post:
tags:
- Buyer Management Service
summary: Get Buyer Details
description: ''
operationId: Get Buyer Details
requestBody:
description: Parameters required to retrieve a Buyer
content:
application/json:
schema:
"$ref": "#/components/schemas/GetBuyerRequest"
examples:
Default:
summary: Default
value:
clientId: B2BWS_1_1_1111
messageId: '107970184447'
buyerId: '200031032'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
"$ref": "#/components/schemas/GetBuyerSuccessResponse"
examples:
Default:
summary: Default
value:
responseObject:
responseFileConfig:
fileLevel:
recipientLoginIds:
commFileId:
fileFormat:
proxyConfig:
holdDays: '180'
bucketedProxyEnabled: false
autoRefreshEnabled: false
boostPaymentConfig:
boostPaymentEnabled: false
contactInfo:
zipCode: '78750'
phone1Ext:
city: Austin
contactName: VisaCompany
phone2Ext:
phone3Ext:
phone2:
phone3:
buyerId: '200031032'
buyerName: '2000131032'
templateId:
phone1: '1234567890'
implementationType: 2
companyId: '2000131032'
emailAddress: [email protected]
countryCode: USA
addressLine1: addr1
addressLine2:
state: TX
addressLine3:
buyerFeatureConfig:
fullAccountViewEnabled: false
cardMaskingDigitsOnline: '12'
vcfDataFeedIndicator: Y
onlinePaymentInstructionEnabled: true
onlinePaymentRequisitionEnabled: true
cardMaskingDigits: '4'
pseudoAccountsEnabled: false
rvaReconciliationFileConfig:
fileLevel: ''
recipientLoginIds: []
commFileId: ''
deliveryTime: ''
deliveryFrequency:
templateId: ''
fileFormat:
paymentFileConfig:
edi824FileId:
edi997FileId:
inboundFileId:
billingConfig:
billingType: I
billingBID: '10048816840'
stripePaymentConfig:
remittanceNotificationEnabled: false
stripePaymentEnabled: false
vanConfig:
fcsBankId:
processingType:
aceClientId:
admClientId:
visaADMOptionId:
mcADMOptionId:
vanEnabled: false
settlementExpirationDays:
stpPaymentConfig:
accountHolderFirstName:
remittanceNotificationEnabled: false
stpPaymentEnabled: false
accountHolderLastName:
webServicesConfig:
apiCodes:
webServicesEnabled: false
clientId:
suppressSupplierNotification: false
vbdsClientId: ''
paymentConfig:
securityCodeRequired: true
allowableCurrencies:
- INR
- USD
expirationDays: '25'
billingCurrency: USD
expirationBufferDays: '5'
defaultSecurityCode: true
paymentAdviceOption: C
paymentSecurityConfig:
defaultSecurityFieldCode: '1'
defaultSecurityQuestion: Credential Text
customSecurityQuestions: []
customSecurityQuestionsEnabled: false
approvalWorkflowConfig:
workflowFunctionCodes: []
workflowConfigEnabled: false
authorizationControlConfig:
authControlPaymentTemplate: Custom_Standard
issuerHoldingBID: ''
authControlEnabled: false
defaultAuthControlEnabled: false
alertsEnabled: false
paymentNotificationConfig:
defaultBuyerLanguageCode: en_US
supplierReminderNotificationDays: '7'
paymentAdviceTemplate: Custom_Standard
settlementSource: '1'
dateFormat: DDMMYYYY
defaultSupplierReminderNotificationEnabled: true
defaultAttachRemittanceDetailsFile: true
supplierReminderNotificationEnabled: true
attachRemittanceDetailsFile: true
reconciliationFileConfig:
fileLevel: ''
recipientLoginIds: []
adhocReconciliationReportEnabled: false
commFileId: ''
deliveryTime: ''
templateName:
deliveryFrequency:
onlinePaymentReconciliationEnabled: false
fileFormat:
processorConfig:
embossedLine2: "<<Buyer Name>> "
closeAccountEnabled: true
processorFields:
aceOptionSet: '1111'
accountIdOptionSet: '1111'
mailerIdOptionSet: '1111'
companyNumber: '1111111'
cycleFrequencyCode: '15'
cmidDefaultValue: ''
unitId: '1000000'
agentNumber: '0000'
cycleFrequencyType: Monthly
suaEmbossedLine1: "<<Buyer Name>>~1"
lodgedEmbossedLine1: "<<Supplier Name>>~1"
responseStatus:
statusDesc: Successfully retrieved the buyer
messageId: '1686861552'
status: success
statusCode: BSGB0000
'400':
description: Refer to the <a href="/pages/B2B-virtual-account-payment-method-error-codes#get_buyer_details">Error
Codes</a> page for the list of error codes for this API.
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
x-samplePayload: ''
x-codegen-request-body-name: body
x-operationVersions:
- label: v1
operationPointer: "#/paths/~1vpa~1v1~1buyerManagement~1buyer~1get/post"
default: false
- label: v2 - Latest
operationPointer: "#/paths/~1vpa~1v2~1buyerManagement~1buyer~1get/post"
default: false
x-hideTryIt: true
"/vpa/v1/buyerManagement/buyerTemplate/create":
post:
tags:
- Buyer Management Service
summary: Create Buyer Template
description: ''
operationId: Create Buyer Template
requestBody:
description: Details of the Template
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateBuyerTemplateRequest"
examples:
Default:
summary: Default
value:
responseFileConfig:
proxyConfig:
holdDays: 2
bucketedProxyEnabled: false
autoRefreshEnabled: false
clientId: B2BWS_1_2_3029
boostPaymentConfig:
boostPaymentEnabled: false
contactInfo:
buyerFeatureConfig:
rvaReconciliationFileConfig:
stripePaymentConfig:
remittanceNotificationEnabled:
stripePaymentEnabled: false
messageId: '1579603814600'
vanConfig:
stpPaymentConfig:
remittanceNotificationEnabled: false
stpPaymentEnabled: false
webServicesConfig:
paymentConfig:
securityCodeRequired: false
allowableCurrencies:
- USD
expirationDays: 30
billingCurrency: USD
expirationBufferDays: 5
paymentAdviceOption: C
paymentFileCommConfig:
paymentSecurityConfig:
defaultSecurityFieldCode: 1
defaultSecurityQuestion: Credential Text
customSecurityQuestions:
customSecurityQuestionsEnabled: false
approvalWorkflowConfig:
workflowFunctionCodes:
- AUCL
- LCRC
- PYIN
- PYRN
workflowConfigEnabled: true
authorizationControlConfig:
issuerHoldingBID: '10029012'
authControlEnabled: true
alertsEnabled: false
paymentNotificationConfig:
defaultBuyerLanguageCode: en_US
supplierReminderNotificationDays: 7
dateFormat: DDMMYYYY
supplierReminderNotificationEnabled: true
attachRemittanceFileDetails: false
templateName: '1579603814600'
templateDescription: VPP Template
reconciliationFileConfig:
processorConfig:
closeAccount:
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateBuyerTemplateSuccessResponse"
examples:
Default:
summary: Default
value:
templateId: '1_2_3029_50'
'400':
description: Refer to the <a href="/pages/B2B-virtual-account-payment-method-error-codes#create_buyer_template">Error
Codes</a> page for the list of error codes for this API.
content:
application/json:
schema:
"$ref": "#/components/schemas/BErrorResponse"
x-samplePayload: ''
x-codegen-request-body-name: template
x-operationVersions:
- label: v1
operationPointer: "#/paths/~1vpa~1v1~1buyerManagement~1buyerTemplate~1create/post"
default: false
x-hideTryIt: true
"/vpa/v1/buyerManagement/buyerTemplate/update":
patch:
tags:
- Buyer Management Service
summary: Update Buyer Template
description: ''
operationId: Update Buyer Template
requestBody:
description: Details of the values in the Template to be updated
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateBuyerTemplateRequest"
examples:
Default:
summary: Default
value:
proxyConfig: ''
clientId: B2BWS_1_Region_Bank_19401
boostPaymentConfig: ''
contactInfo: ''
buyerFeatureConfig: ''
stripePaymentConfig: ''
messageId: '1579804800637'
vanConfig: ''
stpPaymentConfig: ''
webServicesConfig: ''
templateId: '1_1_1940_81'
syncBuyerProfiles: true
paymentConfig: ''
paymentSecurityConfig: ''
approvalWorkflowConfig: ''
authorizationControlConfig:
issuerHoldingBID: '12345678'
authControlEnabled: true
alertsEnabled: ''
paymentNotificationConfig: ''
templateName: '1579804800637'
templateDescription: This ise first test template
reconciliationFileConfig: ''
processorConfig: ''
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateBuyerTemplateSuccessResponse"
examples:
Default:
summary: Default
value:
templateId: '1_1_1940_81'
'400':
description: Refer to the <a href="/pages/B2B-virtual-account-payment-method-error-codes#update_buyer_template">Error
Codes</a> page for the list of error codes for this API.
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
x-samplePayload: ''
x-codegen-request-body-name: template
x-operationVersions:
- label: v1
operationPointer: "#/paths/~1vpa~1v1~1buyerManagement~1buyerTemplate~1update/patch"
default: false
x-hideTryIt: true
"/vpa/v1/buyerManagement/buyer/update":
patch:
tags:
- Buyer Management Service
summary: Update Buyer
description: ''
operationId: Update Buyer
requestBody:
description: Profile Details of the buyer that needs to be updated.
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateBuyerRequest-1"
examples:
Default:
summary: Default
value:
proxyConfig:
holdDays: 3
bucketedProxyEnabled: false
autoRefreshEnabled: false
clientId: B2BWS_1_1_1111
boostPaymentConfig:
boostPaymentEnabled: false
contactInfo:
zipCode: '78759'
phoneExt3: ''
city: Austin
contactName: VisaCompany
phone2: ''
phone3: ''
defaultCurrencyCode: USD
buyerId: '151785'
buyerName: TestPaymentFile
templateId: '1988'
phone1: '8888888888'
companyId: '151785'
emailAddress: [email protected]
countryCode: USA
addressLine1: 12301ResearchBlvd23
phoneExt1: ''
addressLine2: Build#33
state: TX
phoneExt2: ''
addressLine3: 4thfloor
buyerFeatureConfig:
fullAccountViewEnabled: false
cardMaskingDigitsOnline: 12
onlinePaymentInstructionEnabled: false
onlinePaymentRequisitionEnabled: false
cardMaskingDigits: 12
pseudoAccountsEnabled: false
stripePaymentConfig:
remittanceNotificationEnabled: false
stripePaymentEnabled: false
messageId: '1579589087445'
vanConfig:
processingType: '1'
admClientId: '1234'
mcADMOptionId: '12345'
vanEnabled: false
stpPaymentConfig:
accountHolderFirstName: Visa
remittanceNotificationEnabled: false
stpPaymentEnabled: false
accountHolderLastName: Card
webServicesConfig:
apiCodes:
- SMGS
webServicesEnabled: true
clientId: B2BWS_1_1_1111
vbdsDataSubscription:
- dataSubscriptionType: 5001
dataSubscriptionAccountType:
- subscribed: true
accountType: MEMO
- subscribed: true
accountType: NVPA
suppressSupplierNotification: false
vbdsClientId: '12345'
paymentConfig:
securityCodeRequired: false
allowableCurrencies:
- USD
expirationDays: 30
billingCurrency: USD
expirationBufferDays: 5
paymentAdviceOption: C
paymentSecurityConfig:
defaultSecurityFieldCode: 1
defaultSecurityQuestion: ''
customSecurityQuestions:
- birthday
customSecurityQuestionsEnabled: true
approvalWorkflowConfig:
workflowFunctionCodes:
- AUCL
- PYRN
- LCRC
- PYIN
workflowConfigEnabled: true
authorizationControlConfig:
authControlEnabled: true
alertsEnabled: false
paymentNotificationConfig:
supplierReminderNotificationDays: 2
dateFormat: DDMMYYYY
attachRemittanceDetails: false
supplierReminderNotificationEnabled: true
defaultLanguageCode: en_us
processorConfig:
processorFields:
aceOptionSet: 34d2
corporationId: 2r
bin: sd2
cmidDefaultValue: 245d3534
agentNumber: '3453'
principalNumber: '66'
accountIDOptionSet: '3482'
companyNumber: '12344'
authorizationStrategyCode: hh66
pricingStrategy: 66hh
unitId: prop1
mapId: 66hh
processType: '09'
productCodes: sdjssd
user4Code: 345u
hierarchyNode: s3
plasticCode: '9866'
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateBuyerSuccessResponse"
examples:
Default:
summary: Default
value:
responseStatus:
statusDesc: Successfully updated the buyer
messageId: '1686772964'
status: success
statusCode: BSUB0000
'400':
description: Refer to the <a href="/pages/B2B-virtual-account-payment-method-error-codes#update_buyer">Error
Codes</a> page for the list of error codes for this API.
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
x-samplePayload: ''
x-codegen-request-body-name: body
x-operationVersions:
- label: v1
operationPointer: "#/paths/~1vpa~1v1~1buyerManagement~1buyer~1update/patch"
default: false
x-hideTryIt: true
"/vpa/v1/buyerManagement/buyer/create":
post:
tags:
- Buyer Management Service
summary: Create Buyer
description: ''
operationId: Create Buyer
requestBody:
description: Buyer object that needs to be created
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateBuyerRequest-3"
examples:
Default:
summary: Default
value:
proxyConfig:
holdDays: 3
bucketedProxyEnabled: false
autoRefreshEnabled: false
clientId: B2BWS_1_1_1111
boostPaymentConfig:
boostPaymentEnabled: false
contactInfo:
zipCode: '78759'
phoneExt3: ''
city: Austin
contactName: VisaCompany
phone2: ''
phone3: ''
defaultCurrencyCode: USD
buyerId: '8887773'
buyerName: TestPaymentFileLijie14
phone1: '8888888888'
companyId: '8887773'
emailAddress: [email protected]
countryCode: USA
addressLine1: 12301 ResearchBlvd23
phoneExt1: ''
addressLine2: Build#33
state: TX
phoneExt2: ''
addressLine3: 4th floor
buyerFeatureConfig:
fullAccountViewEnabled: false
cardMaskingDigitsOnline: 12
onlinePaymentInstructionEnabled: false
onlinePaymentRequisitionEnabled: false
cardMaskingDigits: 12
pseudoAccountsEnabled: false
paymentFileConfig:
inboundFileId: '700147'
stripePaymentConfig:
remittanceNotificationEnabled: false
stripePaymentEnabled: false
messageId: '1579589087445'
stpPaymentConfig:
accountHolderFirstName: Visa
remittanceNotificationEnabled: false
stpPaymentEnabled: false
accountHolderLastName: Card
webServicesConfig:
apiCodes:
- SMGS
webServicesEnabled: true
clientId: B2BWS_1_1_1111
vbdsDataSubscription:
- dataSubscriptionType: 5001
dataSubscriptionAccountType:
- subscribed: true
accountType: MEMO
- subscribed: true
accountType: NVPA
suppressSupplierNotification: false
vbdsClientId: '12345'
paymentConfig:
securityCodeRequired: false
allowableCurrencies:
- USD
expirationDays: 30
billingCurrency: USD
expirationBufferDays: 5
paymentAdviceOption: C
paymentSecurityConfig:
defaultSecurityFieldCode: 1
customSecurityQuestions:
- birthday
# --- truncated at 32 KB (792 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/visa/refs/heads/main/openapi/b2b-virtual-account-payment-method.yml