B2B Virtual Account Payment Method Codes

messageId

Y

36

• UniqueID to identify the request.
• Must not contain security vulnerability characters.

clientId

Y

25

• ClientID associated with the bank.
• Visa Implementation will provide this.

contactInfo

Y

Optional

Y

100

• Valid email address.
• Used only if the third party wants to use the same email address for all email communications.
• Used for VPC alerts and notifications.

phone1

Optional

N

20

Used only if the third party wants to use the same phone for all communications.

• Valid Values are:  1 – VPA UI, 2 – VPA API and 3 – Visa Travel (Visa Commercial Pay)
• If Buyers will log in to the VPA UI for an Issuer Direct relationship,  select 1.  If buyer is created by a Third party fintech use option 2.  

• Valid Visa 11 digit Billing BID
• Numeric
  
• User should only change this from the Issuer BID if the third party will be billed

• Identifies who will be billed for use of the service
• Valid Values are: I - Issuer,  T - third party, M - Manual

Y

Parent tag

Optional

N

3

30

• The number of days a supplier has to receive their payment before the payment instruction expires. 
• Must be numeric.
• Valid value:  1-999.
• If left blank, it defaults to 30.
• Not required but if field is provided but null/blank, then request will fail. 

N

2

5

• Must be numeric.
• Must not be more than 2 digits.
• Valid value: 1-99.
• Not required but if field is provided but null/blank, then request will fail. 

Y

3

• 3 digit ISO alpha currency code (e.g. USD).
• Must be one of the supported active currencies.

Y

3 (for each currency)

Billing Currency

• 3 digit ISO alpha code (e.g. USD).
• Must be one of the supported billing currencies of the buyer.
• Supports up to 150 currencies.
• If Billing currency is not one of the allowable currencies, system will automatically add it. 

N

Bank setting

• Allow the designated supplier to access the CVV2 for all future payment instructions.
• Valid values are true or false. 

N

1

C for Consolidated

• Valid values:
  • C - consolidated
  • S - split
• All other values will be rejected.

N

Parent Tag

This section needs to be populated only if the bank is enabled for Straight Through Processing (STP) (Buyer-Initiated Payments).

N

Boolean

False

• Valid values:
  • True
  • False
• If bank is not enabled for STP, reject the request if the value is true.

N

Boolean

False

• Valid values:
  • True
  • False
• If bank is not enabled for STP remittance notification, reject the request if the value is true.

N

Parent tag

This section needs to be populated only if the bank is enabled for Stripe.

stripePaymentEnabled

Optional

N

Boolean

False

• Valid values:
  •  True
  • False
• If bank is not enabled for Stripe, reject the request if the value is true.

N

Boolean

False

• Valid values: 
  • True
  • False
• If bank is not enabled for Stripe remittance notification, reject the request if the value is true.

N

Parent tag

This section needs to be populated only if the bank is enabled for Boost.

boostPaymentEnabled

Optional

N

Boolean

False

• Valid values:
  • True
  • False
• If bank is not enabled for Boost, reject the request if the value is true.

Y

Parent tag

defaultLanguageCode

Optional

N

10

 en_US

• Any valid locales like en_us for US English. Refer to the Language Code table.
• Used for Buyer notifications.

dateFormat

Required

Y

10

• Valid values are one of the supported date formats. See the Date Formats table for all available date formats.

attachRemittanceDetails

Optional

N

Boolean

Bank value

• Valid values:
  • True
  • False
• If bank is not enabled for Remittance details attachment, reject the request if the value is true.

N

Boolean

Bank value

• Valid values: 
  • True
  • False
• If bank is not enabled for Supplier Reminder Notification, reject the request if the value is true.

Optional

N

2

7 if the supplier reminder notification  is enabled

• The number of days before the payment instruction expires when a reminder notification will be sent.
• Valid values: 1-99

paymentSecurityConfig

Optional

N

Parent tag

defaultSecurityFieldCode

Optional

N

1

1 (Postal code)

• Valid values:
  • 1 – Postal code 
  • 2 – Supplier ID
• Buyers can choose to use either the Supplier ID or the supplier’s ZIP/postal code as the answer to the default security question.

N

256

 “Credential Text”

• Security vulnerability characters are not allowed.
• This is the phrase the supplier will be prompted with when retrieving full account information

customizeSecurityQuestionsEnabled

Optional

N

Boolean

False

• Valid values: 
  • True
  • False
• Buyers can create a custom security question. The same question must be used for all suppliers.

customSecurityQuestions

Conditional

N

100 

• At least one question needs to be sent if custom security question is enabled.
• Security vulnerability characters should not be allowed for the questions.
• Max of three questions. 100 characters each.

authorizationControlConfig

Optional

Y

Parent tag

This section needs to be populated only if the bank is enabled for auth controls.

authControlEnabled

Conditional

Y

Boolean

• True for  VIP pseudo and TSYS VAN buyers.
• True if mandate auth controls enabled.
• Otherwise, False.

• Valid values:
  • True
  • False
• Should be set to True for VPP and VIP token buyers.
• For memo buyers, this can be True or False
• If the value is not True, and the bank is enabled for mandate auth controls, reject the request.
• Bank payment control indicator should be enabled.

issuerHoldingBID

Conditional 

8

The IssuerHoldingBID set for the bank

• Required if auth controls are enabled & token type is not VPP.
• Valid Visa 8-digit BID.
• Must be numeric.
• Should be populated only if the auth control is enabled for the template or the request will be rejected.

alertsEnabled

Conditional 

Y

Boolean

• Required if auth control is enabled for the buyer (applicable only for VPC enabled template).
• Enables VPC decline email notifications.
• Valid values: 
  • True 
  • False 
• The system will reject the request if this is set to true and the auth controls is not enabled for the template.

Y

Parent tag

cardMaskingDigitsOnline

Optional

Y

2

12

• RESERVED FOR FUTURE USE. Do not use. 
• Must be numeric.  
• Valid values: 0-12.
• Controls masking of account number on the user interface.
• To mask card numbers in API response, contact your Visa implementation resource to configure.

cardMaskingDigits

Optional

Y

2

12

• Must be numeric.  
• Valid values: 0-12
• Controls all recon files and response files.
• To mask card numbers in API response, contact your Visa implementation resource.
  

onlinePaymentInstructionEnabled

Optional

N

Boolean

False

• Denotes if online payment instruction (Pay Now) functionality is enabled for the buyer.  
• Valid values:
  • True
  • False
•  Bank needs to be enabled for this before it is enabled for the template.

N

Boolean

False

• Denotes if online payment requisition functionality is enabled for the buyer.  
• Valid values:
  • True
  • False
• Bank needs to be enabled for this before it is enabled for the template.

N

Boolean

Bank value

• Valid values:
  • True 
  • False
• Bank needs to be enabled for this before it is enabled for the template.

Optional

Y

Boolean

N

• Valid values:
  • True
  • False
• Bank needs to be enabled for this before it is enabled for the template.

approvalWorkflowConfig

Optional

N

Parent tag (Collection of approval workflow functions)

workflowFunctionsEnabled

Optional

N

Boolean

False

• Valid values
  • True 
  • False.
• Bank needs to be enabled for this before it is enabled for the template.

N

2

• Required for adding a workflow function (Workflow Function Enabled is set to True).
• Valid Values:
  • AUCL – Card Limit Update
  • LCRC – Lodge/New Card
  • PYIN – Payment Instruction
  • PYRN – Payment Requisition

Parent tag

webServicesEnabled

Optional

Y

Boolean

False

• Valid values:
  • True
  • False 
• Bank needs to be enabled for this before it is enabled for the template.

Y

50

Every third party will have this ID generated for subscribing to auth/settlement data from VBDS system.

clientId

Optional

Reserved for Future Use.

Reserved for Future Use.

apiCodes

Conditional

Reserved for Future Use.

Reserved for Future Use.

suppressSupplierNotification

Optional

N

Boolean

N

• Valid values:
  • Y 
  • N
• Applicable only when the suppress notification is enabled for the bank.
• Will suppress any supplier notifications such as Payment Remittance Advice, Security questions/answers, reminders, etc. Used when third party provides this information directly to the supplier.

N

Parent tag

Applicable to buyers using the payment process flow, and whose payments are submitted via system-to-system interface.

inboundFileId

Conditional 

N

40

• Required if EDI 820 payment file is sent from the buyer.
• Comm file ID associated with the EDI 820 inbound payment file.
• Should be an existing bank level comm file already setup in COMMs as an inbound to receive EDI 820 format file.

edi997FileId

Optional 

N

40

• Only required if EDI 997 ack file needs to be sent to the buyer.
• Comm file ID associated with the EDI 997 outbound ack file.
• Should be an existing bank level comm file already setup in COMMs as an outbound to send a EDI 997 format file.

edi824FileId

N

40

• Only required if EDI 824 ack file needs to be sent to the buyer.
• Comm file ID associated with the EDI 824 outbound response file.
• Should be an existing bank level comm file already setup in COMMs as an outbound to send a EDI 824 format file.

ResponseFileConfig

Optional

N

Parent tag

Applicable to buyers using the process payment flow and who submit files through system-to-system connection.

commFileId

Conditional

N

40

• Comm File ID associated with the Response file outbound delivery.
• Visa Implementation team will provide this ID.

ReconciliationFileConfig

Optional

N

Parent tag

This reconciliation file is used for the Payment Processing use case.

onlinePaymentReconciliationEnabled

Optional

N

Boolean

False

• Denotes if online payment Reconciliation functionality is enabled for the buyers.
• Valid values: 
  • True
  • False
• Bank needs to be enabled for this before it is enabled for the template.

N

Boolean

False

• Valid values
  • True
  • False
• Bank needs to be enabled for this before it is enabled for the template.
• Enables company admins to trigger the Adhoc Reconciliation file from the VPA UI.

N

40

• Comm File ID associated with the recon file outbound delivery.
• Visa Implementation team will provide this ID.

templateName

Conditional

N

100

Most recent standard recon template

• For Process Payment use case.
• Name of the custom reconciliation file template.
• Required if CommFileID is provided or adhoc recon report is enabled.

rvaReconciliationFileConfig

Optional

Y

Parent tag

This reconciliation file is applicable to those using the Request Virtual Account API.

commFileId

Optional

Y

40

• Comm File ID associated with the RVA Recon file outbound delivery.
• This will be provided by the Visa implementation team.

templateId

Conditional

Y

2

Most recent RVA Recon template version.

• Required if RVA recon is enabled.
• Denotes the id of the recon template to be used for generating the RVA reconciliation file.
• Today there is only one version so you can leave this blank; system will default to the most recent version.
• Valid value: 01 (standard version).
• Should be valid RVA template ID.

proxyConfig

Optional

Y

Parent tag

holdDays

Optional

Y

3 

90 days 

• Numeric.
• Maximum 3 digits.
• SUAs are available for use after the hold days have completed.
• For Payments, Hold days start when the payment is submitted.
• For RVA, Hold days start when the payment requisition end period is reached.

autoRefreshEnabled

Conditional

Y

Boolean

True if the buyer is enabled for pseudo account or VPP, otherwise, it is False.

• Valid values:
  • True
  • False
• Required for Visa Pseudo Accounts and TSYS VPP VANs.

Y

Boolean

False

• Valid values: 
  • True
  • False
• Can be set to True only if the bank is enabled for bucketed Proxy.
• SUA Buckets feature is where VPA dynamically selects an SUA from a “bucket” of fixed accounts with the lowest credit limit that can be used to make the payment.

Y

Parent tag

closeAccount

Conditional

Y

Boolean

True if processor integration is enabled for the bank or buyer is enabled for VIP/VPP tokens.

Otherwise, false.

• Ability to close the account at the processor, or close an account within the token vault.
• Must be true for VIP pseudo accounts and TSYS VPP VAN.
• If processor integration is off, the system should reject the request if the value is True.
• Valid values:
  • True
  • False

Y

Parent tag

Applicable to buyers using TSYS VPP VANs.

vanEnabled

Conditional

Y

Boolean

• Valid values:
  • True
  • False
• Bank needs to be enabled for this before it is enabled for the template.

Y

4

The Bank FCS ID if there is only one setup at the bank level.

• Alphanumeric value.
• Required if template is enabled for TSYS VPP.
• Length is 4 digits.
• Should be one of the values set up for the bank.

SUN/MON/TUE/WED/THU/FRI/SAT

Follow above - enter  3 letters with all caps  

Acquiring Institution ID has these attributes:                                                             

Optional                                                                                                                                     

11 numeric characters                                                                                                         

Cannot be left blank                                                                                                                 

Cannot be duplicated

Spend Velocity Rule

Note: Override codes marked with an asterisk * are required.

Amount ; The maximum amount that can be collected from the card. 

Note: This is based on the range criteria selected.  I.e. if monthly is selected, it will reset every month to the SpendLimitAmount.

Number ; Max number of successful transactions/authorizations the user is allowed to make. This number defaults to zero.

Note: A zero in this field implies no limit on the number of transactions the user can make.  

Number; There are three different range types. Some selections have additional required fields.

rangeType: 1 is Recurring.

For this rangeType, the SPV rule never expires. The SPV rule enabled for a card is reset with its original values on the recurring day for every month clearing the transaction fields (authorization amount, authorization count, and notifications sent and rangeType:1)

If you select this rangeType, you must also specify the recurringDay field. Select a number between 1-28. 

rangeType: 2 is Monthly.

For this rangeType, the SPV rule never expires. The SPV rule enabled for a card is reset with its original values at the start of every month clearing the transaction fields (authorization amount, authorization count, and notifications sent and rangeType:2)

If you select this rangeType, you do not need to enter any additional fields. 

rangeType: 3 is DateRange.

For this rangeType, the SPV rule is only valid for the specified date range.

If you select this rangeType, you must also specify:

•  startDate (in UTC)
• endDate (in UTC)

Formats are YYYY-MM-DD or MM/DD/YYYY

rangeType: 4 is Weekly.

For this specific rangeType, the SPV rule remains valid until the end date of the requisition. The SPV rule, when activated for a card, is reset to its initial values each week on a recurring day, which results in the clearing of transaction details such as the authorization amount, the count of authorizations, and the notifications count.

If you select this rangeType, you must also specify:

"dayOfTheWeek" as one of the following values :SUN,MON,TUE,WED,THU,FRI,SAT

Users are advised to input the timezone for the reset to occur at the appropriate local time. In the absence of a user-specified timezone, the system will default to a daily reset based on Greenwich Mean Time (GMT).

rangeType: 5 is Daily.

For this specific rangeType, the SPV rule remains valid until the end date of the requisition. The SPV rule, when activated for a card, is reset to its initial values each day, which results in the clearing of transaction details such as the authorization amount, the count of authorizations, and the notifications count.

Users are advised to input the timezone for the reset to occur at the appropriate local time. In the absence of a user-specified timezone, the system will default to a daily reset based on Greenwich Mean Time (GMT).

• NOCHANGE/UPDATE: To update the existing SPV by keeping transaction details as is (authorization amount, authorization count, and notifications count). This is the default value.
• REPLACE: update existing SPV rule with the new rule and reset the accrual details to 0 (authorization amount, authorization count, and notifications count).

Note: To update an existing SPV rule, all fields specified in the existing SPV rule must be provided in the request. If not specified, the field(s) will be reset to the default value(s). 

minMCC

maxMCC

Allowed MCC between 0000-9999

Allowed MCC value should be equal to or greater than minMCC

minMCC

maxMCC

Allowed MCC between 0000-9999

Allowed MCC value should be equal to or greater than minMCC

Acquiring Institution ID has these attributes:                                                             

Optional                                                                                                                                     

11 numeric characters                                                                                                         

Cannot be left blank                                                                                                                 

Cannot be duplicated

Note: weekDayEffective is case sensitive 

Only supports US-based time zones (PST, MST, CST and EST).

Allow purchases conducted at fuel/driver merchants.

Allowed MCC Range: 5541 - 5542, 7542 - 7542.

Allow purchases made at auto-rental merchants.

Allowed MCC Range: 3351-3441, 7512-7512.

Allow purchases made at airline merchants.

Allowed MCC Range: 3000-3300, 4511-4511.

Allow purchases made at restaurants.

Allowed MCC Range: 5811-5812, 5814-5815, 5462-5463.

Allow purchases conducted at electronics themed-merchants.

Allowed MCC Range : 4812-4814, 4816-4817, 5044-5045, 5731-5732, 5734-5734, 7372-7379.

Allow purchases at alcohol and tobacco merchants.

Allowed MCC Range: 5813-5813, 5921-5922.

Allow purchases conducted at ground transportation merchants will be declined (includes taxis, trains, and bridge tolls).

Allowed MCC Range:4011-4112, 4121-4131, 4784-4784.

Allow purchases conducted at office supply merchants.

Allowed MCC Range: 5111-5112, 5943-5943, 7332-7361, 7392-7399 and 9402-9403.

Allow purchases conducted at grocery store and pharmacy merchants.

Allowed MCC Range: 5411-5461, 5464-5499.

Allow purchases conducted at entertainment and sports merchants(includes movie theaters,music stores and sporting good stores).

Allowed MCC Range: 7832-7994, 7996-7999.

Allow purchases at utilities (includes cable, phone and electric companies).

Allowed MCC Range: 4814-4815, 4899-4900.

Allow purchases made at medical merchants.

Allowed MCC Range: 4119-4119, 5975-5976, 8011-8099

Allow purchases made at Pharmacies.

Allowed MCC Range: 5122-5123, 5912-5913

Allowed purchases made at General Retail.

Allowed MCC Range: 4225-4225, 5192-5410, 5611-5722, 5923-5942, 5944-5974 and 5977-5999

Allow purchases made at Hotels, Motels, Resorts, Specific lodging establishment.s

Allowed MCC Range: 3501-3838, 7011-7011

• rangeType: 1 is Recurring.
  For this rangeType, the SPV rule never expires. The SPV rule enabled for a card is reset with its original values on the recurring day for every month clearing the transaction fields (authorization amount, authorization count, and notifications sent and rangeType:1)
  If you select this rangeType, you must also specify the recurringDay field. Select a number between 1-28.
• rangeType: 2 is Monthly.
  For this rangeType, the SPV rule never expires. The SPV rule enabled for a card is reset with its original values at the start of every month clearing the transaction fields (authorization amount, authorization count, and notifications sent and rangeType:2)
  If you select this rangeType, you do not need to enter any additional fields.
• rangeType: 3 is DateRange.
  For this rangeType, the SPV rule is only valid for the specified date range.
  If you select this rangeType, you must also specify:
  • lens startDate (in UTC)
  • lensendDate (in UTC)

Formats are YYYY-MM-DD or MM/DD/YYYY
 

recurringDay