# Visa Direct Transfer funds seamlessly, securely and quickly. ## Version: 1 ### Servers | URL | Description | | --- | ----------- | | https://sandbox.api.visa.com | Sandbox server | --- ### Schemas #### 200 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | 200 | string | | | #### ReverseFundsTransactionPostPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The total amount to be sent to the recipient.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | networkId | integer | This contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

Refer to Network ID

Note:
For ReverseFundsTransactions(AFTR) and MultiReverseFundsTransactions (MULTIAFTR) originators must populate the networkId returned in the original PullFundsTransactions(AFT) and MultiPullFundsTransactions (MULTIAFT) response.
Supported only in US for domestic transactions. | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account

Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string, **"paymentFacilitator"**: { **"additionalAcceptor"**: { **"foreignRetailerIndicator"**: string,
**Available values:** "A", "B" } } } | | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | schemeIdentifier | string | Defines the card scheme selected of a co-badged cards for the transaction.Only 2 values supported.
01-Visa
02-Other
The values will expand in future. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is "PS". | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the original transaction.

Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment. | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | merchantCategoryCode | integer | If original AFT found, then the value from AFT overrides the one present in the request. If the merchantCategoryCode value is not there in original AFT then this field is populated from AFTR request.

If not present in AFT/AFTR, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | Yes | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer } | | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.
For Argentina domestic purchase transactions the value should be "PS".

Refer to businessApplicationId codes | Yes | | serviceProcessingType | { **"requestType"**: string } | Optional.

This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction. You must use the transactionIdentifier from the initial AFT in this field. | Yes | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantVolumeIndicator | integer | Merchant Volume Indicator to identify Nano/micro merchants (Peru market) Values: "51" (Micromerchant), "52" (Nanomerchant). | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. however, when passing the Account Funding Transaction Reversal (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | binary | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator.Values in this field must be in the same currency and format as defined in the amount field(minimum value is 0). | No | | senderPaymentCredentialReference | { **"type"**: string,
**Available values:** "PCI_TOKEN_REFID", "PAYMENT_CREDENTIAL_ID", **"value"**: string, **"merchantId"**: string } | Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID Conditional Only one of 'senderPrimaryAccountNumber' and 'senderPaymentCredentialReference' is provided in a request | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | recipientIdentificationNumberBusiness | string | Conditional.

This field contains the identification number issued to the recipient by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number. | No | #### ReverseFundsTransactionPostPayload-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The total amount to be sent to the recipient.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | networkId | integer | This contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

Refer to Network ID

Note:
For ReverseFundsTransactions(AFTR) and MultiReverseFundsTransactions (MULTIAFTR) originators must populate the networkId returned in the original PullFundsTransactions(AFT) and MultiPullFundsTransactions (MULTIAFT) response.
Supported only in US for domestic transactions. | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account

Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is "PS". | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment. | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | merchantCategoryCode | integer | If original AFT found, then the value from AFT overrides the one present in the request. If the merchantCategoryCode value is not there in original AFT then this field is populated from AFTR request.

If not present in AFT/AFTR, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | Yes | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer } | | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.
For Argentina domestic purchase transactions the value should be "PS".

Refer to businessApplicationId codes | Yes | | serviceProcessingType | { **"requestType"**: string } | Optional.

This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction. You must use the transactionIdentifier from the initial AFT in this field. | Yes | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. however, when passing the Account Funding Transaction Reversal (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | binary | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator.Values in this field must be in the same currency and format as defined in the amount field(minimum value is 0). | No | | recipientIdentificationNumberBusiness | string | Conditional.

This field contains the identification number issued to the recipient by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number. | No | #### ReverseFundsTransactionPostPayload-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The total amount to be sent to the recipient. | Yes | | networkId | integer | This contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

Refer to Network ID

Note:
For ReverseFundsTransactions(AFTR) and MultiReverseFundsTransactions (MULTIAFTR) originators must populate the networkId returned in the original PullFundsTransactions(AFT) and MultiPullFundsTransactions (MULTIAFT) response.
Supported only in US for domestic transactions. | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account

Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment. | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | merchantCategoryCode | integer | If original AFT found, then the value from AFT overrides the one present in the request. If the merchantCategoryCode value is not there in original AFT then this field is populated from AFTR request.

If not present in AFT/AFTR, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | Yes | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer } | | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

Refer to businessApplicationId codes | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction. You must use the transactionIdentifier from the initial AFT in this field. | Yes | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. however, when passing the Account Funding Transaction Reversal (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
Note:
If a currency has one decimal place, the last digit of this field must be zero.
If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator.Values in this field must be in the same currency and format as defined in the amount field(minimum value is 0). | No | | senderIdentificationNumberBusiness | string | Conditional.

This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | #### UpdateMerchantAliasRequest Schema Request payload for updating merchant or agent alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Merchant or agent city. | No | | email | string | Merchant or agent email address. | No | | phone | string | Merchant or agent phone number. | No | | aliasId | string | This attribute is used by acquirer to uniquely identify their merchant or agent. | Yes | | country | string | Merchant or agent country code as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | No | | aliasType | string | 01 – Phone number
02 – Email address
03 – USSD Payment ID
04 – BID (Bank Identification Number)
05 – National ID
06 – Custom
Null – Should start with visa assigned USSD Payment ID | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | No | | postalCode | string | Merchant or agent postal code. | No | | isAgentAlias | string | Optional and applicable for agent alias use only. If set as 'Y', agent alias to be updated. | No | | recipientName | string | Merchant or agent name. | No | | convenienceFeeAmount | string | The convenience fee of a fixed amount. Applicable only for merchant alias. | No | | merchantCategoryCode | string | Merchant Category Code. Numeric only. | No | | payloadFormatIndicator | string | Defines the format of the merchant data payload. Payload Format Indicator must be set to '01' as per EMVCo Merchant Presented QR specifications. | No | | pointOfInitiationMethod | string | In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
1st character
'1' = QR
'2' = BLE
'3' = NFC
'4' - '9' = Reserved for Future Use
2nd character
'1' = Static
'2' = Dynamic
'3' - '9' = Reserved for Future Use.
Example: '11' indicates QR static code, '12' indicates QR dynamic code. | No | | transactionCurrencyCode | string | As defined by ISO 4217. This is the transaction currency code that a merchant can accept for payment. 3-digit numeric presentation of the currency is recommended to be used if alias may be used for QR. | No | | convenienceFeePercentage | string | Applicable only for merchant alias. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). | No | | tipConvenienceFeeIndicator | string | Tip or Convenience Fee Indicator. This shall contains a value of '01', '02' or '03' as per EMVCo Merchant Presented QR specifications. Applicable only for merchant alias. | No | #### MerchantVerificationValuemrr Schema Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | mvvVisaAssigned | string | Visa assigned MVV value. E.g. 0A45AF | Yes | | mvvAcquirerAssigned | string | Visa assists the acquirer in assigning the last four. E.g. 98FC | Yes | #### CashOutCardAcceptorAddress Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Originator must populate this field with 'mVisa cashout'. | Yes | | country | string | Must include the 2-character alpha country code of the merchant. | Yes | #### PushFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | Conditional.

If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city.

This field is also conditionally required for domestic Colombia transactions | No | | senderName | string | Conditional.

Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use senderFirstName, senderLastName & senderMiddleName instead.

If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name.

Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

Example: Doe John A | No | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account

Default is set to "00" if not provided. | No | | secondaryId | string | secondaryId is used for C2B use case in the CEMEA region where payee initiates the OCT to the payer. The merchant or acquirer may use this field to obtain an Agreement Id in order to process the request. | No | | acquiringBin | number | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"taxID"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string, **"addressLine"**: string }, **"terminalId"**: string, **"urlAddress"**: string, **"partnerIDCode"**: string, **"legalBusinessName"**: string, **"contactInformation"**: { **"phoneNumber"**: string, **"additionalContactDetails"**: string, **"customerServicePhoneNumber"**: string }, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"country"**: string, **"postalCode"**: string, **"streetAddress"**: string }, **"subMerchantId"**: string, **"independentSalesOrganizationID"**: string }, **"serviceLocationDetails"**: { **"address"**: { **"city"**: string, **"state"**: string, **"postalCode"**: string, **"countryCode"**: string } } } | | Yes | | sourceAmount | double | Conditional.

Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | recipientCity | string | Conditional

This field contains the city name of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientName | string | Conditional.

Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use recipientFirstName, recipientLastName & recipientMiddleName instead.

This field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards.

Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

Example: Doe John A | No | | senderAddress | string | Conditional.

If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address.

Note:
This field is not applicable for domestic Colombia transactions | No | | recipientState | string | Conditional.

This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
Note:
It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements)

Note:
This field is not applicable for domestic Colombia transactions | No | | senderLastName | string | Conditional

This field contains sender's last name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 85 | No | | senderFirstName | string | Conditional

This field contains sender's first name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 83 | No | | senderReference | string | Conditional.

Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
Required, if the transaction is a funds disbursement, the field is required.
Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

Required if senderCountryCode is either 124(CAN) or 840(USA)

Note:
This field not applicable for domestic Colombia transactions | No | | purposeOfPayment | string | Conditional.

This is an alphanumeric value.
Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | senderEntityType | string | Optional.

This field identifies if the sender is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderMiddleName | string | This field contains sender's middle name

Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 84 | No | | senderOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | senderPostalCode | string | Conditional.

When present, this field contains the sender's postal code
Note: Required when cardAcceptor:address:country is US or CA

Note: For domestic Colombia transactions, the maximum length of this field is 16 characters. For other transactions, the entered value should be between 5 and 10 characters. | No | | senderStreetName | string | Optional.

This field contains the street name of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | Conditional.

This field contains a value that identifies the customer.
This field needs to be populated for Argentina domestic transaction where businessApplicationId is "PS". | No | | messageReasonCode | number | Conditional.

Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | Conditional

This field contains recipient's last name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 85 | No | | senderCountryCode | string | Conditional.

If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

Alpha or numeric country code can be supported.

This field is required when sending the transactions to some of the US debit networks.

This field is required when sending the transactions to some of the US debit networks and for domestic Colombia transactions.

Refer to ISO Codes | No | | senderDateOfBirth | date | This field contains the birth date for the sender.
Format: YYYY-MM-DD
Example: 2011-12-30 | No | | senderNationality | string | ISO country code of nationality in alphabets. | No | | sourceOfFundsCode | string | Conditional.

If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

Refer to sourceOfFundsCode codes | No | | pointOfServiceData | { **"panEntryMode"**: number, **"motoECIIndicator"**: number, **"posConditionCode"**: number, **"specialConditionIndicatorMerchant"**: string } | Conditional.

Note: For a CardPresent Transactions, this field is required. | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | This is the invoice number or some other reference for billing purposes.
e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up. | No | | recipientFirstName | string | Conditional

This field contains recipient's first name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 83 | No | | senderAddressLine1 | string | Optional.

This field contains the first line of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderAddressLine2 | string | Optional.

This field contains the second line of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sourceCurrencyCode | string | Conditional.

3-character alpha or numeric currency code for currency of the sourceAmount field.

Refer to ISO Codes | No | | acquirerCountryCode | number | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

Refer to ISO Codes | Yes | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientEntityType | string | Optional.

This field identifies if the recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | recipientMiddleName | string | This field contains recipient's middle name

Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 84 | No | | recipientOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | recipientPostalCode | string | Conditional

This field contains the postal code of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientStreetName | string | This field contains the street name of the recipient address.

Maps to the following ISO 8583 field
- Field 56, Tag 88 | No | | senderAccountNumber | string | Conditional.

If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), this field is required and must contain the sender's account number. If the transaction is a funds disbursement, the field is not required.

Note: This is a 16-digit PAN or token which defines the account of the consumer (sender of push payment). | No | | senderMiddleInitial | string | This field contains sender's middle initial.

Note:
This field is not applicable for domestic Colombia transactions | No | | merchantCategoryCode | number | Conditional.

If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

Note: required if not provided during onboarding | No | | recipientCountryCode | string | Conditional.

This field contains the ISO 3166-1 country code of the recipient address.

Refer to ISO Codes
Note:
It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientDateOfBirth | date | Account Owner Date of Birth.(format YYYY-MM-DD) | No | | recipientNationality | string | ISO country code of nationality in alphabets. | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"ancillarySenderDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ] } | | No | | senderBuildingNumber | string | Optional.

This field contains the house or the building number of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCountryOfBirth | string | ISO country code of birth in alphabets | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

For Argentina domestic purchase transactions the value should be "PS".

For Request To Pay, city will carry Invoice Id which will be used for C2B use case in the CEMEA region where payee initiates the OCT to the payer.

Refer to businessApplicationId codes | Yes | | recipientAddressLine1 | string | Conditional.

This field contains the first line of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientAddressLine2 | string | Optional.

This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | number | Conditional.

The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response. For Faster Refunds OCTs, clients are required to include the Visa Transaction ID from the original purchase transaction. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial.
Note:
Supported for Push Payments transactions associated with Gateway Service. (Refer to Mastercard data processing requirements) | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa.

Note: For BAI as MI, either this field or cardAcceptor.paymentFacilitator.id or both should be present. | No | | merchantPseudoAbaNumber | string | Conditional.

This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ], **"ancillaryRecipientDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | date | Conditional.

This field contains the expiration date for the recipient's primary account number or token in recipientPrimaryAccountNumber.
Note: Visa requires expiration date to be present in all OCTs destined to U.S. issuers
Format: YYYY-MM
Example: 2021-10 | No | | recipientCountryOfBirth | string | ISO country code of birth in alphabets | No | | systemsTraceAuditNumber | number | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. You should (unless prohibited by local law / regulation) use the billingCurrencyCode obtained from the Funds Transfer Attribute Inquiry API under Payment Account Attribute Inquiry.

Refer to ISO Codes | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
Format: YYYY-MM-DDThh:mm:ss
Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3.
Note: If a currency has three decimal places, the last digit of this field must be zero. | No | | retrievalReferenceNumber | number | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format : ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPersonalEmailAddress | string | Account owner email address. | No | | settlementServiceIndicator | number | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: number, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: number, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | recipientPersonalEmailAddress | string | Account owner email address. | No | | recipientPrimaryAccountNumber | string | This is a 16-digit PAN or token for the account of the recipient of push payment. | Yes | | recipientSubDivisionMinorCode | string | Optional.

This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address.

Note:
This field is not applicable for domestic Colombia transactions | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | senderIdentificationNumberBusiness | string | Conditional.

This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | senderIdentificationNumberIndividual | string | Conditional.

This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification. | No | #### InquiryDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | This attribute contains the Alias data, e.g. phone number, email address, etc.
If phone number is used for Alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. | Yes | | aliasType | string | “01” – Phone number
“02” – Email address
“03” – National ID
“04” – IBAN (International Bank Account Number) | Yes | | paymentInstrOwner | string,
**Available values:** "REQUESTOR", "OTHER" | Indicates if the returned payment instrument belongs to the originator. "REQUESTOR" if the payment instrument belongs the originator. "OTHER" if the payment instrument does not belong to the originator.
*Enum:* `"REQUESTOR"`, `"OTHER"` | Yes | | paymentInstrTypes | [ string ] | Provides returned Alias mapped to CARD or ACCOUNT. Default the value is CARD. | No | #### CancelDeferredPushFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The action code of the cancelled deferred OCT request.

25 : Unable to locate deferred OCT request.
R0 : No action taken. Deferred OCT transaction already cancelled.
57 : Transaction not permitted to cardholder.
21 : Deferred OCT is under processing, cannot be cancelled.
85 : Deferred OCT cancellation successful. | Yes | | transactionIdentifier | number (int64) | The VisaNet reference number for the cancelled deferred OCT request. | Yes | #### MultiPullFundsTransactionRequests Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | cavv | string | The Cardholder Authentication Verification Value (CAVV) is a value generated by an Access Control Server (ACS) and signed by the Issuer using account and password information of cardholders registered for the Verified by Visa program. This field should be in hexabinary format. | No | | amount | double | The amount of the transaction, inclusive of all fees you assess for the transaction, including currency conversion fees. If the originator is populating the surcharge or foreignExchangeFeeTransaction field, they must be included in the amount field.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | pinData | { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | When present, this field contains sender's city | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | cardCvv2Value | string | The cardCvv2Value provided by the account holder for the senderPrimaryAccountNumber in the request. | No | | senderAddress | string | When present, this field contains sender's Address | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | recipientState | string | Required if RecipientCountryCode is either 124(CAN) or 840(USA) | No | | senderLastName | string | This field contains sender's last name | No | | senderFirstName | string | This field contains sender's first name | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | When present, this field contains sender's state code | No | | senderPostalCode | string | When present, this field contains the sender's postal code | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | integer | Conditional.

This field is required to identify whether a transaction is merchant-initiated.
Note: Message reason code and POS Environment fields are mutually exclusive.

Refer to Meassage Reason Codes | No | | recipientLastName | string | When present, this field contains recipient's last name | No | | senderCountryCode | string | when present, this field contains sender's country code

Refer to ISO Codes | No | | sourceOfFundsCode | string | when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.

Refer to sourceOfFundsCode codes | No | | magneticStripeData | { **"track1Data"**: string, **"track2Data"**: string } | | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
Note: For a CardPresent Transactions, this field is required. | Yes | | recipientFirstName | string | When present, this field contains recipient's first name | No | | riskAssessmentData | { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | senderAccountNumber | string | When present, this field contains the sender's account number. This field is mandatory in cross-border AFTs it will contain the destination account number being funded with the AFT (e.g. IBAN number for loading a bank account, proprietary wallet number for loading a wallet, prepaid PAN number for loading a card, money transfer operator proprietary account number with acquirer for funding a money transfer). | No | | senderMiddleInitial | string | This field contains sender's middle initial | No | | recipientCountryCode | string | when present, this field contains recipient's country code

Refer to ISO Codes | No | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber | Yes | | originalTransactionId | integer | Conditional.

This field is required to identify whether a transaction is merchant-initiated

Note: Merchants must link the Merchant-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring, installment, and unscheduled COF), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | addressVerificationData | { **"street"**: string, **"postalCode"**: string } | Conditional
Address verification is required for an AFT transaction to qualify for CPS. Either send the card’s postal code or full address.
Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
Either the postalCode or full address of the card is required.
Please reach out to your Visa representative for details. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
Note:
If a currency has one decimal place, the last digit of this field must be zero.
If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator). Values in this field must be in the same currency and format as defined in the amount field. | No | | recipientIdentificationNumberBusiness | string | Conditional.

This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)

If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

AA
PP
TU
BI
WT
FT

This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transaction when businessApplicationId:PS | No | | recipientIdentificationNumberIndividual | string | Conditional.

This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is an Individual (e.g. P2P payments)

If recipientIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

AA
PP
TU
BI
WT
FT
| No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

Note:Supported only in US for CPS (Custom Payment Service).

This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.
Please reach out to your Visa representative for details. | No | #### MultiReverseFundsTransactionPostPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"amount"**: double, **"networkId"**: integer, **"surcharge"**: string (double), **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"memberComments"**: string, **"senderReference"**: string, **"sharingGroupCode"**: string, **"merchantReference"**: string, **"pointOfServiceData"**: { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer }, **"senderCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"originalDataElements"**: { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer }, **"senderCardExpiryDate"**: string, **"transactionIdentifier"**: long, **"merchantPseudoAbaNumber"**: string, **"systemsTraceAuditNumber"**: integer, **"enablerVerificationValue"**: string, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"pointOfServiceCapability"**: { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer }, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"senderPrimaryAccountNumber"**: string, **"settlementServiceIndicator"**: integer, **"foreignExchangeFeeTransaction"**: double, **"senderIdentificationNumberBusiness"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country where the Visa Direct solution is registered. This must match the information provided during program enrollment.

Refer to ISO Codes | Yes | | merchantCategoryCode | integer | If original AFT found, then the value from AFT overrides the one present in the AFTR request. If the merchantCategoryCode value is not there in original AFT then this field is populated from AFTR request.

If not present in AFT/AFTR, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

Refer to businessApplicationId codes | No | | localTransactionDateTime | dateTime | | Yes | #### MultiReverseFundsTransactionPostPayload-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"amount"**: double, **"networkId"**: integer, **"surcharge"**: string (double), **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"memberComments"**: string, **"senderReference"**: string, **"sharingGroupCode"**: string, **"merchantReference"**: string, **"pointOfServiceData"**: { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer }, **"senderCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"originalDataElements"**: { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer }, **"senderCardExpiryDate"**: string, **"transactionIdentifier"**: long, **"merchantPseudoAbaNumber"**: string, **"systemsTraceAuditNumber"**: integer, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"pointOfServiceCapability"**: { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer }, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"senderPrimaryAccountNumber"**: string, **"settlementServiceIndicator"**: integer, **"foreignExchangeFeeTransaction"**: double, **"senderIdentificationNumberBusiness"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country where the Visa Direct solution is registered. This must match the information provided during program enrollment.

Refer to ISO Codes | Yes | | merchantCategoryCode | integer | If original AFT found, then the value from AFT overrides the one present in the AFTR request. If the merchantCategoryCode value is not there in original AFT then this field is populated from AFTR request.

If not present in AFT/AFTR, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

Refer to businessApplicationId codes | No | | localTransactionDateTime | dateTime | | Yes | #### MagneticStripeDataV2V2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | MagneticStripeDataV2V2 | { **"track1Data"**: string } or { **"track2Data"**: binary } | | | #### MerchantAliasResponse-1 Schema Response if a merchant or agent is successfully created,updated or deleted. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasId | string | Identifier uniquely assigned by Acquirer to a merchant. This identifier of a merchant or agent of acquirer is returned if alias operation in Alias Directory is successful | No | #### PersonToMerchantResponse Schema Response body for Receive Person-to-Merchant API | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | merchantID | string | Conditional. Recipient may replace this field with card acceptor ID code of the merchant as defined in recipient system. If replaced by recipient, all occurrences of card acceptor ID code in reports, files, transaction inquiries, etc. will contain the value provided by the recipient. This field is to be sent as NULL if it is not populated. | No | | merchantCity | string | This is called Card Acceptor Location. Recipient may replace this field with the city name of Merchant. Visa settlement reports would contain the value provided by recipient.
If encounter errors or the merchant PAN is invalid/does not belong to the acquirer, the acquirer should send HTTP 200 with decline response code and echo back the same field content sent in the request.
Note:This field, if present, should be sent together with merchantName and merchantCountryCode. Otherwise none of them should be sent in the response. | No | | merchantName | string | This is called Card Acceptor Name in the VisaNet Specifications. Recipient may replace this field with the ‘doing business as’ name of Merchant. Visa settlement reports would contain the value provided by recipient.
If encounter errors or the merchant PAN is invalid/does not belong to the acquirer, the acquirer should send HTTP 200 with decline response code and echo back the same field content sent in the request.
Note:This field, if present, should be sent together with merchantCity and merchantCountryCode. Otherwise none of them should be sent in the response. | No | | responseCode | string | Contains a code (also known as 'Action Code') that defines the response to a request. Refer to actionCode. | Yes | | authIdResponse | string | Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipient maintains uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. This field is to be sent as NULL if it is not populated. | No | | posConditionCode | string | If the acquirers do not provide this value, a default of “01” (customer not present) will be assumed for interchange assessment.
Refer to POS Condition Code. | No | | memberSuppliedIRF | string | Acquirer may provide the interchange fee amount for P2M transaction and its only relevant for LAC regional markets. This field is to be sent as NULL if it is not populated. List of Countries supported:
1. Costa Rica
2. Dominican Republican
3. Venezuela
4. Guatemala | No | | merchantTerminalID | string | Conditional. Recipient may replace this field with card acceptor terminal ID as defined in recipient system. If replaced by recipient, all occurrences of card acceptor terminal ID in reports, files, transaction inquiries, etc. will contain the value provided by the recipient. This field is to be sent as NULL if it is not populated. | No | | feeProgramIndicator | string | Optional field which may be populated by recipient where applicable. This field is to be sent as NULL if it is not populated. | No | | merchantCountryCode | string | Conditional. Recipient may replace this field with the 2-letter ISO 3166 country code of the merchant, if the country code of recipient is different than originator. Visa settlement reports would contain the value provided by recipient. This field is to be sent as NULL if it is not populated.
Note:This field, if present, should be sent together with merchantName and merchantCity. Otherwise none of them should be sent in the response. | No | | merchantCategoryCode | string | Recipient should populate the Merchant Category Code (MCC) of the merchant in the response message. If replaced by recipient Visa settlement reports would contain the value provided by recipient. This field accepts only numeric data. If there is non numeric data provided in this field the default '0000' translation will be sent to VisaNet.
If encounter errors or the merchant PAN is invalid/does not belong to the acquirer, the acquirer should send HTTP 200 with decline response code and echo back the same field content sent in the request. | No | | receiverTransactionId | string | Acquirer may provide a transaction ID that can be used for investigation if required. This field is to be sent as NULL if it is not populated | No | | reimbursementAttribute | string | This field contains a code that identifies the applicable interchange reimbursement fee for the transaction. Please contact your Regional Visa Client Support Services Representative to identify the value that you should be using. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | argentinaReimbursementFee | string | Acquirer may provide the Argentina member supplied reimbursement fee for P2M transaction. This field is to be sent as NULL if it is not populated | No | | merchantVerificationValue | string | Recipient are expected to populate the Merchant Verification Value used to identify merchants that participate in a variety of programs in this field. This field is to be sent as NULL if it is not populated. | No | #### MerchantVerificationValue Schema Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | mvvVisaAssigned | string | Visa assigned MVV value. E.g. 0A45AF | Yes | | mvvAcquirerAssigned | string | Visa assists the acquirer in assigning the last four. E.g. 98FC | Yes | #### CashInCardAcceptor Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | Populate the field with Merchant's Doing Business As name (25 characters only). If the name is greater than 25 characters, use the first 25 characters. The name must be populated using the Roman i.e. English character set. | Yes | | idCode | string | Originator can populate the field with any system generated reference number internal to originating client. | Yes | | address | { **"city"**: string, **"country"**: string } | | No | #### PullFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | cavv | string | The Cardholder Authentication Verification Value (CAVV) is a value generated by an Access Control Server (ACS) and signed by the Issuer using account and password information of cardholders registered for the Verified by Visa (also known as Visa Secure) program. This field should be in hexabinary format. | No | | tavv | string | The Token Authentication Verification Value (TAVV) is a value generated using tokenized PAN by Visa Token Service (VTS) and signed by the Issuer. This field should be in hexabinary format.

Note: A token should be send (instead of a PAN) in senderPrimaryAccountNumber field while sending a TAVV cryptogram. | No | | amount | double | The amount of the transaction, inclusive of all fees you assess for the transaction, including currency conversion fees. If the originator is populating the surcharge or foreignExchangeFeeTransaction field, they must be included in the amount field.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | pinData | { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | When present, this field contains sender's city | No | | senderName | string | Conditional.

Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use senderFirstName, sendertLastName & senderMiddleName instead.

If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name.

Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

Example: Doe John A | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account

Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"taxID"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string, **"addressLine"**: string }, **"terminalId"**: string, **"urlAddress"**: string, **"partnerIDCode"**: string, **"legalBusinessName"**: string, **"contactInformation"**: { **"phoneNumber"**: string, **"additionalContactDetails"**: string, **"customerServicePhoneNumber"**: string }, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"country"**: string, **"postalCode"**: string, **"streetAddress"**: string }, **"subMerchantId"**: string, **"independentSalesOrganizationID"**: string }, **"serviceLocationDetails"**: { **"address"**: { **"city"**: string, **"state"**: string, **"postalCode"**: string, **"countryCode"**: string } } } | | Yes | | cardCvv2Value | string | The cardCvv2Value value provided by the account holder for the senderPrimaryAccountNumber in the request. | No | | recipientCity | string | Conditional

This field contains the city name of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientName | string | Conditional.

Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use recipientFirstName, recipientLastName & recipientMiddleName instead.

This field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards.

Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

Example: Doe John A | No | | senderAddress | string | When present, this field contains sender's Address

Note:
This field is not applicable for domestic Colombia transactions | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | recipientState | string | Required if RecipientCountryCode is either 124(CAN) or 840(USA)

Note:
This field is not applicable for domestic Colombia transactions | No | | senderLastName | string | Conditional

This field contains sender's last name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 85 | No | | senderFirstName | string | Conditional

This field contains sender's first name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 83 | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

Required if senderCountryCode is either 124(CAN) or 840(USA)

Note:
This field not applicable for domestic Colombia transactions | No | | purposeOfPayment | string | Conditional.

This is an alphanumeric value.
Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market.
For India, Bangladesh, Egypt and Argentina-Purpose of payment is mandatory for all BAIs except CO,CI and MP
For Chile-Purpose of payment is mandatory for BAI-FD
For Colombia-Purpose of payment is mandatory for BAI-AA and PP | No | | senderEntityType | string | Optional.

This field identifies if the sender is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderMiddleName | string | This field contains sender's middle name

Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 84 | No | | senderOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | senderPostalCode | string | When present, this field contains the sender's postal code

Note: For domestic Colombia transactions, the maximum length of this field is 16 characters. For other transactions, the entered value should be between 5 and 10 characters. | No | | senderStreetName | string | Optional.

This field contains the street name of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | chipConditionCode | integer | Optional.
This field applies to magnetic stripe read transactions where the card and terminal are chip capable. The field does not apply to VSDC transactions where the chip is read; it is used only when the chip card's magnetic stripe is read instead of the chip.
Valid values include:
0- Not applicable to fallback transactions. For chip read transactions this field must contain a 0 or be excluded from the message.
1 - This value applies to fallback transactions. Transaction was initiated from a magnetic stripe with a service code beginning with 2 or 6 and the last read at VSDC terminal was a successful chip read or was not a chip transaction.
2- This value applies to fallback transactions. Transaction was initiated at a chip-capable terminal from a magnetic stripe that contains service code 2 or 6 , and the previous transaction initiated by that terminal was an unsuccessful chip read. | No | | merchantReference | string | Conditional.

This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is "PS". | No | | messageReasonCode | integer | Conditional.

This field is required to identify whether a transaction is merchant-initiated.
Note: Message reason code and POS Environment fields are mutually exclusive.

Refer to Meassage Reason Codes | No | | recipientLastName | string | Conditional

This field contains recipient's last name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 85 | No | | senderCountryCode | string | when present, this field contains sender's country code

Refer to ISO Codes | No | | senderDateOfBirth | date | Account Owner Date of Birth.(format YYYY-MM-DD) | No | | senderNationality | string | ISO country code of nationality in alphabets. | No | | sourceOfFundsCode | string | when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.

Refer to sourceOfFundsCode codes | No | | magneticStripeData | { **"track1Data"**: string, **"track2Data"**: string } | | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
Note: For a CardPresent Transactions, this field is required. | Yes | | recipientFirstName | string | Conditional

This field contains recipient's first name

Required for transaction routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 83 | No | | riskAssessmentData | { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"scaEnvironmentOutageIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | | No | | senderAddressLine1 | string | Optional.

This field contains the first line of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderAddressLine2 | string | Optional.

This field contains the second line of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | masterCardUCAFField | string | This field contains Mastercard e-commerce Universal Cardholder Authentication data in encrypted form. It may also contain Mastercard telephone order data. | No | | recipientEntityType | string | Optional.

This field identifies if the recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | recipientMiddleName | string | This field contains recipient's middle name

Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

Maps to the following ISO 8583 field
- Field 56, Tag 84 | No | | recipientOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | recipientPostalCode | string | Conditional

This field contains the postal code of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientStreetName | string | This field contains the street name of the recipient address.

Maps to the following ISO 8583 field
- Field 56, Tag 88 | No | | senderAccountNumber | string | When present, this field contains the sender's account number. This field is mandatory in XB AFTs it will contain the destination account number being funded with the AFT (e.g. IBAN number for loading a bank account, proprietary wallet number for loading a wallet, prepaid PAN number for loading a card, money transfer operator proprietary account number with acquirer for funding a money transfer). | No | | senderMiddleInitial | string | This field contains sender's middle initial

Note:
This field is not applicable for domestic Colombia transactions | No | | merchantCategoryCode | integer | Note: If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

If not provided, then the value will default to the values provided during onboarding (when the services are provisioned). | Yes | | recipientCountryCode | string | when present, this field contains recipient's country code

Refer to ISO Codes | No | | recipientDateOfBirth | date | Account Owner Date of Birth.(format YYYY-MM-DD) | No | | recipientNationality | string | ISO country code of nationality in alphabets. | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"ancillarySenderDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ] } | | No | | senderBuildingNumber | string | Optional.

This field contains the house or the building number of the sender address.

Note:
This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCardExpiryDate | date | This field contains the expiration date for the sender's Visa account number or token in senderPrimaryAccountNumber
Format: YYYY-MM
Example: 2021-10 | Yes | | senderCountryOfBirth | string | ISO country code of birth in alphabets | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

For Argentina domestic purchase transactions the value should be "PS".

Refer to businessApplicationId codes | Yes | | originalTransactionId | integer | Conditional.

This field is required to identify whether a transaction is merchant-initiated

Note: Merchants must link the Merchant-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring, installment, and unscheduled COF), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions. | No | | recipientAddressLine1 | string | Conditional.

This field contains the first line of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientAddressLine2 | string | Optional.

This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string } | Optional.

This field will contain values that identify the type of service the transaction should be processed. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial

Note:
This field is not applicable for domestic Colombia transactions | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | addressVerificationData | { **"street"**: string, **"postalCode"**: string } | Conditional
Address verification is required for an AFT transaction to qualify for CPS. Either send the card’s postal code or full address.

Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
Either the postalCode or full address of the card is required.

Please reach out to your Visa representative for details. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ], **"ancillaryRecipientDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

This field contains the house or building number of the recipient address. | No | | recipientCountryOfBirth | string | ISO country code of birth in alphabets | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | binary | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | This field contains the local date and time of the transaction takes place originated from merchant, service provider or acquirer.
Format: YYYY-MM-DDThh:mm:ss
Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | If present, this field should contain the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer, **"acceptsPartialAuthorizations"**: string,
**Available values:** "TRUE", "FALSE" } | Note: For a CardPresent Transactions, this field is required. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | integratedCircuitCardData | { **"amountCryptogram"**: double, **"countryCodeTerminal"**: string, **"formFactorIndicator"**: string, **"unpredictableNumber"**: string, **"applicationCryptogram"**: string, **"customerExclusiveData"**: string, **"issuerApplicationData"**: string, **"visaDiscretionaryData"**: { **"derivationKeyIndexVIS"**: string, **"cardVerificationResultsVIS"**: string, **"cryptogramVersionNumberVIS"**: string }, **"dateTerminalTransaction"**: string, **"amountCryptogramCashback"**: double, **"chipTransactionIndicator"**: integer, **"terminalCapabilityProfile"**: string, **"interfaceDeviceSerialNumber"**: string, **"terminalVerificationResults"**: string, **"amountCryptogramCurrencyCode"**: string, **"applicationInterchangeProfile"**: string, **"applicationTransactionCounter"**: string, **"cryptogramTransactionTypeCode"**: integer, **"amountCryptogramCashbackCurrencyCode"**: string, **"chipAuthenticationReliabilityIndicator"**: integer } | This field contains integrated circuit card (ICC)-related data that is transmitted in contact and contactless VSDC transactions from the ICC to the card issuer. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | optionalResponseParameters | string | Originators may choose to specify any or all of the following optional parameters to receive as part of the API response.

E.g. Originators may specify comma-separated, optional parameters such as optionalResponseParameters (motoECIIndicator), if they want to receive motoECIIndicator in the API response.

motoECIIndicator: Identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet) or the type of mail or telephone order. Acquirers supply indicator values, which V.I.P. forwards in requests and advices to issuers that have successfully tested to receive them. The subfield is dropped if issuers have not successfully completed testing or choose not to receive it.

Refer to Moto ECI Codes

E.g. optionalResponseParameters (motoECIIndicator) | No | | senderPersonalEmailAddress | string | Account owner email address. | No | | senderPrimaryAccountNumber | string | This is a 16-digit PAN or token of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator). Values in this field must be in the same currency and format as defined in the amount field. | No | | recipientPersonalEmailAddress | string | Account owner email address. | No | | recipientSubDivisionMinorCode | string | Optional.

This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address.

Note:
This field is not applicable for domestic Colombia transactions | No | | remoteCommerceAcceptorIdentifier | string | This field contains a merchant identifier encoded as Base64. For example website URL or reverse domain name. | No | | masterCardUCAFCollectionIndicator | string | E-commerce indicator that Mastercard Universal Cardholder Authentication data is included in the message. | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | recipientAccountIdentificationData | { **"recipientAccountIdentifierValue"**: string, **"recipientAccountIdentifierTypeCode"**: string } | | No | | recipientIdentificationNumberBusiness | string | Conditional.

This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)

If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

AA
PP
TU
BI
WT
FT

For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN). | No | | recipientIdentificationNumberIndividual | string | Conditional.

This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is an Individual (e.g. P2P payments)

If recipientIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

AA
PP
TU
BI
WT
FT
| No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation)

Note: Supported only in US for CPS (Custom Payment Service).

This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.

Please reach out to your Visa representative for details. | No | | digitalSecureRemotePaymentTokenCryptogram | string | This field contains Mastercard digital payment/Cryptogram data associated with the token. | No | #### PaymentAccountAttributesInquiry Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | issuerName | string | Issuer name of the consumer card. | Yes | | cardTypeCode | string | The code of account funding source for the card, e.g. Credit, Debit, Prepaid, Charge, Deferred Debit.
Refer to cardTypeCode | No | | tokenIndicator | string | This field will determine if the payment instrument provided is a Visa token or a PAN. If the tokenIndicator field is “Y”, the payment instrument in the Resolve API response is a Visa token. If the tokenIndicator field is “N”, the payment instrument in the Resolve API response is a PAN. | No | | geoRestrictionInd | string | This field will determine if the recipient issuer can accept transactions from the Originator country. If the value is 'Y', transactions cannot be accepted from the sender country. If the value is 'N', transactions are allowed. | No | | fastFundsIndicator | string | Indicates the funds delivery speed of the PAN submitted in the request. If the value is 'B', 'C', or 'D', funds will be available to the recipient within 30 minutes of successful transfer. If the value is 'N', the funds will be available within 2 business days of successful transfer.
Refer to fastFundsIndicator | Yes | | billingCurrencyCode | integer | Use a 3-digit numeric currency code for the card billing currency of the PAN.
Refer to ISO Codes | Yes | | cardIssuerCountryCode | string | Refer to ISO Codes | Yes | | pushFundsBlockIndicator | string | Indicates whether the PAN submitted in the request can receive Push Funds(OCTs).
Refer to pushFundsBlockIndicator | Yes | | onlineGambingBlockIndicator | string | Indicates whether the PAN submitted in the request can receive Push Funds(OCTs) for gambling-type transactions. If the value is 'Y', then the account cannot receive gambling Push Funds (OCTs). If the value is 'N', the account can receive gambling Push Funds (OCTs). | Yes | | billingCurrencyCodeMinorDigits | string | Identifies the number of decimal positions that should be present in any amounts for the requested card's billing currency. | No | #### PullFundsTransactionGetResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

Refer to actionCode
| Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: : The VisaNet Response Source for the transaction | Yes | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z
Note: Remove "000Z" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request. | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

Note:
transactionIdentifier is a Visa generated field that client recieves in the response message.
Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.) | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified)

Note:Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details. | No | #### DeleteMerchantAliasRequest-1 Schema Request payload data for deleting an merchant or agent alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasId | string | This attribute is uniquely used by acquirer to identify their merchant or agent. | Yes | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | Yes | | isAgentAlias | string | Optional and applicable for agent alias use only. If set as 'Y', agent alias to be created. | No | #### MultiReverseFundsTransactionRequests-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The total amount to be sent to the recipient.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | networkId | integer | This contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

Refer to Network ID

Note:
For ReverseFundsTransactions(AFTR) and MultiReverseFundsTransactions (MULTIAFTR) originators must populate the networkId returned in the original PullFundsTransactions(AFT) and MultiPullFundsTransactions (MULTIAFT) response.
Supported only in US for domestic transactions. | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer } | | No | | senderCurrencyCode | string | Use a 3-character alpha currency code for currency of the sender.

Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer } | | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction. You must use the transactionId from the initial AFT in this field. | Yes | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method where this is required. however, when passing the Account Funding Transaction Reversal (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
Note:
If a currency has one decimal place, the last digit of this field must be zero.
If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderIdentificationNumberBusiness | string | Conditional.

This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### PullFundsTransactionGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | This field will be present in a partially approved AFT transaction. It will contain the original transaction amount (i.e. the "amount" field value in the AFT request) . This amount will be represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | tokenData | { **"minimumAccountRange"**: integer, **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

Refer to actionCode
| Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: : The VisaNet Response Source for the transaction | Yes | | approvedAmount | double | This field will be present in a partially approved AFT transaction. It will contain the amount approved by the card issuer, and is represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

Refer to cavvResultCode | No | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
Refer to cvv2ResultsCode
*Example:* `"string"` | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z
Note: Remove "000Z" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request. | Yes | | riskAssessmentResults | { **"exemptionReasonCode"**: [ string ], **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | This object is present in the response only if the issuer supports SCA exemptions. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction

Note:
transactionIdentifier is a Visa generated field that client recieves in the response message.
Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.) | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | addressVerificationResults | string | Results of the Address Verification Service (AVS) validation for the Primary Account Number.
Refer to addressVerificationResults
*Example:* `"string"` | No | | masterCardElectronicCommerceIndicators | string | This field contains the security-level indicator for Mastercard issuer-authenticated transactions. | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified)

Note:Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details. | No | #### PullFundsTransactionGetResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | This field will be present in a partially approved AFT transaction. It will contain the original transaction amount (i.e. the "amount" field value in the AFT request) . This amount will be represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | tokenData | { **"minimumAccountRange"**: integer, **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

Refer to actionCode
| Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: : The VisaNet Response Source for the transaction | Yes | | approvedAmount | double | This field will be present in a partially approved AFT transaction. It will contain the amount approved by the card issuer, and is represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z
Note: Remove "000Z" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request. | Yes | | riskAssessmentResults | { **"exemptionReasonCode"**: [ string ], **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | This object is present in the response only if the issuer supports SCA exemptions. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction

Note:
transactionIdentifier is a Visa generated field that client recieves in the response message.
Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.) | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | addressVerificationResults | string | Results of the Address Verification Service (AVS) validation for the Primary Account Number.
Refer to addressVerificationResults
*Example:* `"string"` | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified)

Note:Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details. | No | #### MultiReverseFundsTransactionRequests-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The total amount to be sent to the recipient | Yes | | networkId | integer | This contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

Refer to Network ID

Note:
For ReverseFundsTransactions(AFTR) and MultiReverseFundsTransactions (MULTIAFTR) originators must populate the networkId returned in the original PullFundsTransactions(AFT) and MultiPullFundsTransactions (MULTIAFT) response.
Supported only in US for domestic transactions. | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer } | | No | | senderCurrencyCode | string | Use a 3-character alpha currency code for currency of the sender.

Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer } | | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction. You must use the transactionId from the initial AFT in this field. | Yes | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method where this is required. however, when passing the Account Funding Transaction Reversal (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
Note:
If a currency has one decimal place, the last digit of this field must be zero.
If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderIdentificationNumberBusiness | string | Conditional.

This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### MerchantCardAcceptor Schema It is optional for recipient to send card acceptor field in the response. However, if it is in the response, all merchant name, city and country need to be there. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | Originator can populate this field with value captured from merchant information display. If manual entered transaction then populate default value of 'mVisa merchant'. | Yes | | idCode | string | Originator can populate the field with any system generated reference number internal to originating client. | No | | address | { **"city"**: string, **"country"**: string } | | Yes | #### aliases-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | Conditional. This attribute contains the alias data, e.g. phone number, email address, etc.
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | | aliasType | string | Conditional.
“01” – Phone number
“02” – Email address
“03” – National ID
“04” – IBAN (International Bank Account Number).
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | | isDefault | string | Conditional. This attributes contains whether or not this is the default account to receive money.
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | #### EnablerVerificationValueMRR Schema Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | EnablerVerificationValueMRR | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | | #### PullFundsTransactionGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | This field will be present in a partially approved AFT transaction. It will contain the original transaction amount (i.e. the "amount" field value in the AFT request) . This amount will be represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | tokenData | { **"minimumAccountRange"**: integer, **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

Refer to actionCode
| Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: : The VisaNet Response Source for the transaction | Yes | | approvedAmount | double | This field will be present in a partially approved AFT transaction. It will contain the amount approved by the card issuer, and is represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z
Note: Remove "000Z" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request. | Yes | | riskAssessmentResults | { **"exemptionReasonCode"**: [ string ], **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | This object is present in the response only if the issuer supports SCA exemptions. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction

Note:
transactionIdentifier is a Visa generated field that client recieves in the response message.
Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.) | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | addressVerificationResults | string | Results of the Address Verification Service (AVS) validation for the Primary Account Number.
Refer to addressVerificationResults
*Example:* `"string"` | No | | masterCardElectronicCommerceIndicators | string | This field contains the security-level indicator for Mastercard issuer-authenticated transactions. | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified)

Note:Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details. | No | #### aliases-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | Conditional. This attribute contains the alias data, e.g. phone number, email address, etc.
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts | Yes | | aliasType | string | Conditional.
“01” – Phone number
“02” – Email address
“03” – National ID
“04” – IBAN (International Bank Account Number).
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | | isDefault | string | Conditional. This attributes contains whether or not this is the default account to receive money.
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | #### aliases-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | Conditional. This attribute contains the alias data, e.g. phone number, email address. | Yes | | aliasType | string | Conditional.
“01” – Phone number
“02” – Email address
“03” – National ID
“04” – IBAN (International Bank Account Number). | Yes | | isDefault | string | Conditional. This attribute indicates whether the recipientPrimaryAccountNumber is the default account to receive money for this alias. | Yes | #### GetAliasResponse-1 Schema Response data when a consumer alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city belonging to the payment instrument | No | | guid | string | This attribute is uniquely used by an Issuer to identify the payment instrument belonging to a consumer cardholder.
An Issuer may pass their existing unique identifier of a cardholder's payment instrument in their system to Visa Alias Directory Service as a guid.

One alias can be linked to more than one account. For example, one phone can be linked to three different cards with one of these cards selected as the default card to receive money. It is recommended that the Issuer use systematic naming to generate a guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
alias 85291112222, guid abcd12345678z01 for PAN1 (default)
alias 85291112222, guid abcd12345678z02 for PAN2
alias 85291112222, guid abcd12345678z03 for PAN3

If an issuer creates a new Alias with a guid that is already associated with another Alias, the existing record will be deleted and the new Alias will be created. | Yes | | status | string | The status of an alias. For a consumer alias, this value can be 'INACTIVE' or 'ACTIVE'. | No | | aliases | { **"alias"**: string, **"aliasType"**: string, **"isDefault"**: string } | | No | | country | string | Consumer’s country code belonging to the payment instrument as defined by ISO 3166. As defined by ISO 3166. For aliases created after the September 2023 release, country will be returned in ISO3166-Alpha3 format for resolve response. For aliases created before the September 2023 release, country will be returned in whatever format was provided at the time of the Alias creation. | Yes | | address1 | string | Address line 1 belonging to the payment instrument | No | | address2 | string | Address line 2 belonging to the payment instrument | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum | Yes | | isDefault | string | Conditional. This attribute indicates whether the recipientPrimaryAccountNumber is the default account to receive money for this alias. | No | | expiryDate | string | Card expiration date. | Yes | | issuerName | string | This is name of the Issuer of the consumer's card | Yes | | postalCode | string | Consumer’s postal code belonging to the payment instrument | No | | contactEmail | string | Consumer’s contact email | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss.
It is in Coordinated Universal Time (UTC). | No | | recipientLastName | string | Consumer's last name. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | Yes | | contactPhoneNumber | string | Consumer’s contact phone number | No | | recipientFirstName | string | Consumer’s first name | Yes | | recipientMiddleName | string | Consumer’s middle name | No | | recipientLastNameLocal | string | Consumer’s last name in local language. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | No | | recipientFirstNameLocal | string | Consumer’s first name in local language | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language | No | | recipientPrimaryAccountNumber | string | Consumer’s card number | Yes | #### ReverseFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The total amount to be sent to the recipient.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | networkId | integer | This contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

Refer to Network ID

Note:
For ReverseFundsTransactions(AFTR) and MultiReverseFundsTransactions (MULTIAFTR) originators must populate the networkId returned in the original PullFundsTransactions(AFT) and MultiPullFundsTransactions (MULTIAFT) response.
Supported only in US for domestic transactions. | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account

Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

If the transaction is a funds disbursement, the field is required.

This field is required if senderAccountNumber is not sent. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is "PS". | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment. | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | merchantCategoryCode | integer | If original AFT found, then the value from AFT overrides the one present in the request. If the merchantCategoryCode value is not there in original AFT then this field is populated from AFTR request.

If not present in AFT/AFTR, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | Yes | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer } | | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.
For Argentina domestic purchase transactions the value should be "PS".

Refer to businessApplicationId codes | Yes | | serviceProcessingType | { **"requestType"**: string } | Optional.

This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction. You must use the transactionIdentifier from the initial AFT in this field. | Yes | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. however, when passing the Account Funding Transaction Reversal (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | binary | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format: ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator.Values in this field must be in the same currency and format as defined in the amount field(minimum value is 0). | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | recipientIdentificationNumberBusiness | string | Conditional.

This field contains the identification number issued to the recipient by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number. | No | #### ErrorResponseURL Schema Error response data. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | url | string | Conditional. An URL of a landing page that contains participating issuers will be returned to originator if an alias cannot be found in Visa Alias Directory and HTTP status code = 404. Originator can notify unregistered recipient with this URL so that he/she can select preferred issuer for alias registration.
Note:This attribute is only applicable to selective markets, contact Visa representative for details. | No | | reason | string | Conditional. Reason of the unexpected error. This attribute will not be returned if attribute 'url' is returned. | No | | message | string | Conditional. Error description of the unexpected error. This attribute will not be returned if attribute 'url' is returned. | No | #### MerchandiseReturnTransactionResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | It contains a code that defines the response to a request.
Refer to actionCode | Yes | | approvalCode | string | The authorization code from the issuer. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | This must be the same value as in the original response. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system. The VisaNet Response Source for the transaction | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | required when call times out | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | Optional field which may be populated by recipient where applicable. | No | | transmissionDateTime | dateTime | Transmission date and time | Yes | | transactionIdentifier | string | It contains a right-justified, VisaNet generated Transaction Identifier (TID). | Yes | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

This field will not be sent in the response if the transaction is ineligible for token services. | No | | retrievalReferenceNumber | string | This is a key data element for matching a message to others within a given transaction set. | No | #### AdjustFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

Refer to actionCode | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | supplementalData | { **"dcapIndicator"**: string } | This field will contain supplemental values for a transaction. | No | | customerReference | string | This field contains a value that identifies the customer.
This field will be populated in the response for Argentina domestic AFT Credit Adjustment, transactions when businessApplicationId is "PS". | No | | merchantReference | string | This field contains the merchant account key value for Argentina domestic purchase (POS) transactions.
This field will be populated in the response for Argentina domestic, OCT Debit Adjustment, transactions where businessApplicationId is "PS". | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | tokenAssuranceMethod | string | This field contains different category value to determine the Risk Score associated with the token and transaction. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | number | Visa transaction identifier . | Yes | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

This field will not be sent in the response if the transaction is ineligible for token services. | No | | dateAndTimeTransmission | dateTime | This field contains the year, month, day, and time the transaction was processed by Visa Direct. Example: 2020-05-21T08:03:00.000Z | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | senderIdentificationNumberIndividual | string | This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification.
This field will be populated in the response for Argentina domestic AFT Credit Adjustment, transactions when businessApplicationId is "PS". | No | | recipientIdentificationNumberBusiness | string | For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN).
This field will be populated in the response for Argentina domestic OCT Debit Adjustment, transactions where businessApplicationId is "PS". | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified)

Note:Supported only in US for CPS (Custom Payment Service). Please reach out to your Visa representative for details. | No | #### content-2 Schema Depending on the selected type of alias reports, this contains a list of consumer, merchant or agent alias records. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | Conditional. Only applicable for consumer alias report. This attribute is uniquely used by issuer to identify their cardholders (i.e. consumer). | No | | status | string | The status of an alias.
For consumer alias, this value can be 'ACTIVE', 'DISABLED' or 'INACTIVE'.
For merchant/agent alias, this value can be 'ACTIVE' or 'DISABLED'. | No | | aliasId | string | Conditional. Only applicable for merchant/agent alias report. This attribute is used by acquirer to uniquely identify their merchant or agent. | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | No | | statusChangeDateTime | string | The date and time when the status of an alias is changed. It is in Coordinated Universal Time (UTC). | No | #### CardAcceptormrresponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | | No | | idCode | string | Recipient may replace this field with any system generated reference number internal to the recipient. | No | | terminalId | string | Recipient may replace this field card acceptor terminal ID as defined in recipient system. If replaced by recipient Visa settlement reports would contain the value provided by recipient. | No | #### CashOutCardAcceptorResponse Schema It is optional for recipient to send card acceptor field in the response. However, if it is in the response, all merchant name, city and country need to be there. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | Recipient can replace this field with the 'doing business as' name of merchant. Visa settlement reports would contain the value provided by recipient. | Yes | | idCode | string | Retain and return same field value from the request. | No | | address | { **"city"**: string, **"country"**: string } | | Yes | #### content-1 Schema Depending on the selected type of alias reports, this contains a list of consumer, merchant or agent alias records. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | Conditional. Only applicable for consumer alias report. This attribute is uniquely used by issuer to identify their cardholders (i.e. consumer). | No | | status | string | The status of an alias.
For consumer alias, this value can be 'ACTIVE', 'DISABLED' or 'INACTIVE'.
For merchant/agent alias, this value can be 'ACTIVE' or 'DISABLED'. | No | | aliasId | string | Conditional. Only applicable for merchant/agent alias report. This attribute is used by acquirer to uniquely identify their merchant or agent. | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | No | #### Track1Data Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | track1Data | string | Conditional Note: For a cardPresent scenario, magneticStripeData.track1Data (or magneticStripeData.track2Data) must be included. Note: These fields are only available in OCT transactions in specific geographies. Please reach out to your Visa representative for details | Yes | **Example** 
B4000340099900505^John/Doe ^22251110000123000
#### CashInResponse Schema Response body for Receive Cash-In API | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | responseCode | string | Contains a code (also known as 'Action Code') that defines the response to a request. Refer to actionCode | Yes | | authIdResponse | string | Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipient maintains uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. This field is to be sent as NULL if it is not populated. | No | | receiverTransactionId | string | Acquirer may provide a transaction ID that can be used for investigation if required. This field is to be sent as NULL if it is not populated | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | #### PullFundsTransactionPostResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | This field will be present in a partially approved AFT transaction. It will contain the original transaction amount (i.e. the "amount" field value in the AFT request) . This amount will be represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

Refer to Network ID

Note:
This field is returned only if it is anything other than networkId value 2.

Supported only in US for domestic transactions. | No | | tokenData | { **"minimumAccountRange"**: integer, **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

Refer to actionCode | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN), when a token (instead of a PAN) is used in the transaction. | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: : The VisaNet Response Source for the transaction | Yes | | approvedAmount | double | This field will be present in a partially approved AFT transaction. It will contain the amount approved by the card issuer, and is represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

Note: When using dual cryptograms (both TAVV and CAVV ), If TAVV is valid than cavvResultCode would convey the outcome of the CAVV validation.

Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | supplementalData | { **"dafIndicator"**: string } | This field will contain supplemental values for a transaction. | No | | customerReference | string | Conditional

This field contains a value that identifies the customer. | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | pointOfServiceData | { **"motoECIIndicator"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
Note: The .SSS portion received in the PullFundsTransactions POST response will be ignored in the following ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request.
Format: yyyy-MM-ddTHH:mm:ss.SSS
Example: 2016-01-15T07:03:52.000Z | Yes | | riskAssessmentResults | { **"exemptionReasonCode"**: [ string ], **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | This object is present in the response only if the issuer supports SCA exemptions. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction

Note:
transactionIdentifier is a Visa generated field that client recieves in the response message.
Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | Conditional
If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
Please reach out to your Visa representative for details. | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | addressVerificationResults | string | Results of the Address Verification Service (AVS) validation for the Primary Account Number.
Refer to addressVerificationResults
*Example:* `"string"` | No | | senderIdentificationNumberIndividual | string | Conditional

This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification. | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).

Note: Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details. | No | #### PullFundsTransactionPostResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | This field will be present in a partially approved AFT transaction. It will contain the original transaction amount (i.e. the "amount" field value in the AFT request) . This amount will be represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

Refer to Network ID

Note:
This field is returned only if it is anything other than networkId value 2.

Supported only in US for domestic transactions. | No | | tokenData | { **"minimumAccountRange"**: integer, **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

Refer to actionCode | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN), when a token (instead of a PAN) is used in the transaction. | No | | approvalCode | string | The authorization code from the issuer. | No | | chipCardData | string | A blob containing the Chip card data in TLV format
*Example:* `"8201495F2A0201245F34010182021C008407A0000000031010950580000000009A031102249B0268009C01009F02060000000000009F03060000000000009F0607A00000000310109F0802008C9F0902008C9F100706010A039000009F1A0201249F2608423158936ED6C38F9F2701809F3303E0B0C89F34034103029F3501229F360200019F3704ACAC66E89F5800DF0100DF0200DF0400"` | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: : The VisaNet Response Source for the transaction | Yes | | approvedAmount | double | This field will be present in a partially approved AFT transaction. It will contain the amount approved by the card issuer, and is represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

Note: When using dual cryptograms (both TAVV and CAVV ), If TAVV is valid than cavvResultCode would convey the outcome of the CAVV validation.

Refer to cavvResultCode | No | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
Refer to cvv2ResultsCode
*Example:* `"string"` | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | supplementalData | { **"dafIndicator"**: string, **"dcapIndicator"**: string } | This field will contain supplemental values for a transaction. | No | | customerReference | string | Conditional

This field contains a value that identifies the customer. | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | pointOfServiceData | { **"motoECIIndicator"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
Note: The .SSS portion received in the PullFundsTransactions POST response will be ignored in the following ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request.
Format: yyyy-MM-ddTHH:mm:ss.SSS
Example: 2016-01-15T07:03:52.000Z | Yes | | riskAssessmentResults | { **"exemptionReasonCode"**: [ string ], **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | This object is present in the response only if the issuer supports SCA exemptions. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction

Note:
transactionIdentifier is a Visa generated field that client recieves in the response message.
Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | Conditional
If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
Please reach out to your Visa representative for details. | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

This field will not be sent in the response if the transaction is ineligible for token services. | No | | merchantVolumeIndicator | integer | Merchant Volume Indicator to identify Nano/micro merchants (Peru market) Values: "51" (Micromerchant), "52" (Nanomerchant). | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | addressVerificationResults | string | Results of the Address Verification Service (AVS) validation for the Primary Account Number.
Refer to addressVerificationResults
*Example:* `"string"` | No | | senderIdentificationNumberIndividual | string | Conditional

This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification. | No | | masterCardElectronicCommerceIndicators | string | This field contains the security-level indicator for Mastercard issuer-authenticated transactions. | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).

Note: Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details. | No | #### MultiPushFundsTransactionRequests Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3
Note: If a currency has three decimal places, the last digit of this field must be zero.
If a currency has 0 minor unit, this field must carry no fractional points.
If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city. | Yes | | senderName | string | Conditional.

If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's name.

If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the name of the merchant or government entity sending the funds disbursement.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's name.
Required, if the transaction will be routed to Maestro & STAR networks via Visa Push Payments Gateway Service (PPGS). If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. PPGS uses senderName if all the following fields are available: senderName, senderFirstName, senderLastName and senderMiddleName

Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

Example: Doe John A | Yes | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

00-Not applicable
10-Saving account
20-Checking account
30-Credit card account
40-Universal account

Default is set to "00" if not provided. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | sourceAmount | double | Conditional

Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | recipientCity | string | Conditional

This field contains the city name of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientName | string | Recipient name is required for cross-border enhanced money transfer OCTs. | No | | senderAddress | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address. | Yes | | recipientState | string | Conditional.

This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
Note:
It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements) | No | | senderLastName | string | Conditional.

This field contains sender's last name
Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs or the PPGS implementation guide.

If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | senderFirstName | string | Conditional.

This field contains sender's first name
Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs and the PPGS implementation guide.

If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | senderReference | string | Conditional.

Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
Required, if the transaction is a funds disbursement, the field is required.
Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Required if SenderCountryCode is either 124(CAN) or 840(USA) | No | | purposeOfPayment | string | Conditional

This is an alphanumeric value.
Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | senderMiddleName | string | This field contains sender's middle name
If this field is sent it will be passed to networks, as an optional field, through which transaction is routed when using Visa Push Payments Gateway Service (PPGS). | No | | senderPostalCode | string | When present, this field contains the sender's postal code | Yes | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

Refer to Sharing Group Code

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | integer | Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases.
For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | When present, this field contains recipient's last name | No | | senderCountryCode | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

Alpha or numeric country code can be supported.

This field is required when sending the transactions to some of the US debit networks.

Refer to ISO Codes | No | | senderDateOfBirth | string | The birth date for the sender | No | | sourceOfFundsCode | string | If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

Refer to sourceOfFundsCode codes | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | This is the invoice number or some other reference for billing purposes.
e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up. | No | | recipientFirstName | string | When present, this field contains recipient's first name | No | | sourceCurrencyCode | string | Conditional

3-character alpha or numeric currency code for currency of the sourceAmount field.

Refer to ISO Codes | No | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientMiddleName | string | This field contains recipient's middle name | No | | recipientPostalCode | string | Conditional

This field contains the postal code of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientStreetName | string | Optional.

This field contains the street name of the recipient address. | No | | senderAccountNumber | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), and if the SenderCardId attribute is not sent, this field is required and must contain the sender's account number.

If the transaction is a funds disbursement, the field is not required. | No | | senderMiddleInitial | string | This field contains sender's middle initial | No | | recipientCountryCode | string | Conditional.

This field contains the ISO 3166-1 country code of the recipient address.

Refer to ISO Codes
Note:
It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine1 | string | Conditional.

This field contains the first line of the recipient address.
Note:
It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine2 | string | Optional.

This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

Note:
Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientBuildingNumber | string | Optional.

This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | string | The expiration date for the recipient's primary account number in recipientPrimaryAccountNumber | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. You should (unless prohibited by local law / regulation) use the billingCurrencyCode obtained from the Funds Transfer Attribute Inquiry API under Payment Account Attribute Inquiry.

Refer to ISO Codes | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

Recommended Format : ydddhhnnnnnn

The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
Note:
If a currency has one decimal place, the last digit of this field must be zero.
If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

Valid values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement

Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | recipientPrimaryAccountNumber | string | The recipient's PAN. | Yes | | recipientSubDivisionMinorCode | string | Optional.

This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address. | No | | senderIdentificationNumberBusiness | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements) | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains customer's VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | #### CreateMerchantAliasRequest-1 Schema Request payload data for creating a merchant or agent alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Merchant or agent city. | Yes | | aliasId | string | This attribute is used by acquirer to uniquely identify their merchant or agent. | Yes | | country | string | Merchant or agent country code as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | Yes | | aliasType | string | 01 – Phone number
02 – Email address
03 – USSD Payment ID
04 – BID (Bank Identification Number)
05 – National ID
06 – Custom
Null – Should start with visa assigned USSD Payment ID | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | Yes | | isAgentAlias | string | Optional and applicable for agent alias use only. If set as 'Y', agent alias to be created. | No | | recipientName | string | Merchant or agent name. | Yes | | convenienceFeeAmount | string | The convenience fee of a fixed amount. Applicable only for merchant alias. | No | | merchantCategoryCode | string | Merchant Category Code. Numeric only. | Yes | | payloadFormatIndicator | string | Defines the format of the merchant data payload. Payload Format Indicator must be set to '01' as per EMVCo Merchant Presented QR specifications. | Yes | | pointOfInitiationMethod | string | In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
1st character
'1' = QR
'2' = BLE
'3' = NFC
'4' - '9' = Reserved for Future Use
2nd character
'1' = Static
'2' = Dynamic
'3' - '9' = Reserved for Future Use.
Example: '11' indicates QR static code, '12' indicates QR dynamic code. | No | | transactionCurrencyCode | string | As defined by ISO 4217. This is the transaction currency code that a merchant can accept for payment. 3-digit numeric presentation of the currency is recommended to be used if alias may be used for QR. | Yes | | convenienceFeePercentage | string | Applicable only for merchant alias. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). | No | | tipConvenienceFeeIndicator | string | Tip or Convenience Fee Indicator. This shall contains a value of '01', '02' or '03' as per EMVCo Merchant Presented QR specifications. Applicable only for merchant alias. | No | #### CashInRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | agentCity | string | Agent city name. | Yes | | encAgentName | string | Contains Agent’s Doing Business as name (25 characters only). If the name is greater than 25 characters then the first 25 characters are populated. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). | Yes | | originatorBIN | string | This BIN number identifies the originator of Cash-In payment transaction. | Yes | | encConsumerPAN | string | Consumer PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionAmount | string | Transaction amount in local currency. mVisa program rules do not permit cross border cash deposit transactions. | Yes | | visaTransactionId | string | Numeric. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | localTransactionDate | string (mmdd) | It contains the local month and day on which the transaction was originated. The date is in mmdd format. | Yes | | localTransactionTime | string (hhmmss) | The time the transaction takes place, expressed in the local time of the originator. The time is in hhmmss format. | Yes | | transmissionDateTime | string (MMDDhhmmss) | The date and time the request was submitted to Visa. Format: MMDDhhmmss. | Yes | | originatorCountryCode | string | A 3-digit ISO-4217 code that identifies the country of the originating BIN.
Refer to ISO codes. | Yes | | systemTraceAuditNumber | string | Numeric. It is a key data element used to match a response to its request or to match a message to others for a given transaction. | Yes | | velocityLimitIndicator | string | Conditional. This field contains the velocity limit related information that Acquirer can use in making the authorization decision:
  • 1 = 1-day count or amount exceeded.
  • 2 = 7-day count or amount exceeded.
  • 3 = 30-day count or amount exceeded.
The field is populated with priority of 1, 2 and then 3.
This field is sent if recipient has opted for VisaNet to forward them the OCT when a velocity limit has been exceeded.
This field will be sent as NULL if it is not populated. | No | | transactionCurrencyCode | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the transactionAmount field. | Yes | | decimalPositionIndicator | string | Indicates the number of decimal positions following the amount field. This field is to be sent as NULL if it is not populated. | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | Numeric. It is a key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. The format is recommended to be ydddhhnnnnnn. | Yes | #### ErrorResponse Schema Error response data. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | reason | string | Reason of the unexpected error. | No | | message | string | Error description of the unexpected error. | No | #### PullFundsTransactionPostResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

Refer to Network ID

Note:
This field is returned only if it is anything other than networkId value 2.

Supported only in US for domestic transactions. | No | | tokenData | { **"minimumAccountRange"**: integer } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

Refer to actionCode | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN), when a token (instead of a PAN) is used in the transaction. | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: : The VisaNet Response Source for the transaction | Yes | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

Note: When using dual cryptograms (both TAVV and CAVV ), If TAVV is valid than cavvResultCode would convey the outcome of the CAVV validation.

Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
Refer to actionCode
Note: This field is only present, when the request is identified as a duplicate. | No | | pointOfServiceData | { **"motoECIIndicator"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
Note: The .SSS portion received in the PullFundsTransactions POST response will be ignored in the following ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request.
Format: yyyy-MM-ddTHH:mm:ss.SSS
Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

Note:
transactionIdentifier is a Visa generated field that client recieves in the response message.
Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | Conditional
If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
Please reach out to your Visa representative for details. | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

This field will not be sent in the response if the transaction is ineligible for token services. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).

Note: Supported only in US for CPS (Custom Payment Service).
Please reach out to your Visa representative for details. | No | #### UpdateAliasRequest-2 Schema Request payload for updating an alias of a consumer. Issuer can delete an optional field by sending an empty string in the attribute in the request

Note. This API only allows issuer to update data field(s) of one mapping of an alias to an account one at a time. To update data field(s) of
  • the mappings of multiple aliases linked to the same PAN; and/or
  • the mappings of one alias linked to multiple accounts
issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer's city belonging to the payment instrument | No | | guid | string | This attribute is uniquely used by an Issuer to identify the payment instrument belonging to a consumer cardholder.
An Issuer may pass their existing unique identifier of a cardholder's payment instrument in their system to Visa Alias Directory Service as a guid.

One alias can be linked to more than one account. For example, one phone can be linked to three different cards with one of these cards selected as the default card to receive money. It is recommended that the Issuer use systematic naming to generate a guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
alias 85291112222, guid abcd12345678z01 for PAN1 (default)
alias 85291112222, guid abcd12345678z02 for PAN2
alias 85291112222, guid abcd12345678z03 for PAN3

If an issuer creates a new Alias with a guid that is already associated with another Alias, the existing record will be deleted and the new Alias will be created. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
CountryCountry CodeExamples
United States11650xxxxxxx
Ukraine38038067xxxxxxx
Belarus37537529xxxxxxx
Kazakhstan77701xxxxxxx
United Kingdom444478xxxxxxxx
Singapore65659xxxxxxx
Hong Kong8528529xxxxxxx
Kenya254254701xxxxxx
| No | | country | string | Consumer's country code belonging to the payment instrument as defined by ISO 3166. The country code will be stored in ISO3166-Alpha3 format for standardization purposes. | No | | newGuid | string | New unique identifier generated by the issuer if the issuer would like to change the existing guid to a new value. | No | | address1 | string | Address line 1 belonging to the payment instrument | No | | address2 | string | Address line 2 belonging to the payment instrument | No | | cardType | string | Conditional. Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum.
This field is required if recipientPrimaryAccountNumber is present in request | No | | aliasType | string | Conditional. aliasType is required if alias is present in the request.
“01” – Phone number
“02” – Email address | No | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
| No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM. | No | | issuerName | string | Conditional. This is the name of the Issuer of the consumer's card.
This field is required if recipientPrimaryAccountNumber is present in request | No | | postalCode | string | Consumer’s postal code belonging to the payment instrument | No | | paymentType | string | Only “PAN” is accepted. Values such as “” or “pan” will be defaulted to “PAN”. All other values will be rejected. | No | | contactEmail | string | Consumer’s contact email for all communications | No | | originalAlias | string | Conditional. This attribute contains the original alias data, e.g. phone number, email address, etc. The data format should follow same as that of the attribute 'alias'.
Note. This attribute is mandatory to all the markets except for United Republic of Tanzania, Zimbabwe, Ghana, Kenya, Mauritius, Nigeria, Senegal, Côte d'Ivoire. | No | | consentDateTime | string | Date & time when consumer has provided their consent to issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | No | | originalAliasType | string | Conditional.
“01” – Phone number
“02” – email address
“03” – National ID
“04” – IBAN (International Bank Account Number).
Note. This attribute is mandatory to to all the markets except for United Republic of Tanzania, Zimbabwe, Ghana, Kenya, Mauritius, Nigeria, Senegal, Côte d'Ivoire. | No | | recipientLastName | string | Consumer’s last name. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | No | | contactPhoneNumber | string | Consumer’s contact phone number for all communications | No | | recipientFirstName | string | Consumer’s first name | No | | recipientMiddleName | string | Consumer’s middle name | No | | recipientLastNameLocal | string | Consumer’s last name in local language. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | No | | recipientFirstNameLocal | string | Consumer’s first name in local language | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language | No | | recipientPrimaryAccountNumber | string | Consumer's card number | No | #### EnablerVerificationValue Schema Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | EnablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | | #### UpdateAliasRequest-1 Schema Request payload for updating an alias of a consumer.

Note. This API only allows issuer to update data field(s) of one mapping of an alias to an account one at a time. To update data field(s) of
  • the mappings of multiple aliases linked to the same PAN; and/or
  • the mappings of one alias linked to multiple accounts
issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer's City | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
guid abcd12345678z01, alias 85291112222
guid abcd12345678z01, alias 85288881111.

For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
alias 85291112222, guid abcd12345678z01 for PAN1 (default)
alias 85291112222, guid abcd12345678z02 for PAN2
alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
CountryCountry CodeExamples
United States11650xxxxxxx
United Kingdom444478xxxxxxxx
Singapore65659xxxxxxx
Hong Kong8528529xxxxxxx
Kenya254254701xxxxxx

If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
CountryExample
IrelandIE29AIBK93115212345678
where
Country Code: IE
Check digits: 29
Bank Identifier: AIBK
Branch Identifier: 931152
Account Number:12345678
| No | | country | string | Country code of the consumer as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | No | | newGuid | string | New unique identifier generated by issuer for a consumer if issuer would like to change the existing guid to a new value. | No | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Conditional. Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum.
This field is required if recipientPrimaryAccountNumber is present in request | No | | aliasType | string | “01” – Phone number
“02” – Email address
“03” – National ID
“04” – IBAN (International Bank Account Number) | No | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
Note. This attribute is only applicable to selected markets that allow to have one alias linked to multiple accounts. | No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM. | Yes | | issuerName | string | Conditional. This is the issuer name of recipient’s card.
This field is required if recipientPrimaryAccountNumber is present in request | No | | postalCode | string | Consumer’s postal code | No | | paymentType | string | This attribute to accept paymentType as “PAN” | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | originalAlias | string | Conditional. This attribute contains the original alias data, e.g. phone number, email address, etc. The data format should follow same as that of the attribute 'alias'.
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | consentDateTime | string | Date & time when consumer has provided their consent to issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | No | | originalAliasType | string | Conditional.
“01” – Phone number
“02” – email address
“03” – National ID
“04” – IBAN (International Bank Account Number).
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | recipientLastName | string | Last name of the consumer. | No | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | No | | recipientMiddleName | string | Consumer’s middle name. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer's card number. | No | #### AliasInquirySummary Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasesFound | integer | Number of Aliases found | Yes | | aliasesTotal | integer | Number of Aliases in request | Yes | | aliasesNotFound | integer | Number of Aliases not found | Yes | #### UpdateAliasRequest-4 Schema Request payload for updating an alias of a consumer.

Note. This API only allows issuer to update data field(s) of one mapping of an alias to an account one at a time. To update data field(s) of
  • the mappings of multiple aliases linked to the same PAN; and/or
  • the mappings of one alias linked to multiple accounts
issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer's City | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
guid abcd12345678z01, alias 85291112222
guid abcd12345678z01, alias 85288881111.

For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
alias 85291112222, guid abcd12345678z01 for PAN1 (default)
alias 85291112222, guid abcd12345678z02 for PAN2
alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
CountryCountry CodeExamples
United States11650xxxxxxx
United Kingdom444478xxxxxxxx
Singapore65659xxxxxxx
Hong Kong8528529xxxxxxx
Kenya254254701xxxxxx

If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
CountryExample
IrelandIE29AIBK93115212345678
where
Country Code: IE
Check digits: 29
Bank Identifier: AIBK
Branch Identifier: 931152
Account Number:12345678
| No | | country | string | Country code of the consumer as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | No | | newGuid | string | New unique identifier generated by issuer for a consumer if issuer would like to change the existing guid to a new value. | No | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Conditional. Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum.
This field is required if recipientPrimaryAccountNumber is present in request | No | | aliasType | string | “01” – Phone number
“02” – Email address
“03” – National ID
“04” – IBAN (International Bank Account Number) | No | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
Note. This attribute is only applicable to selected markets that allow to have one alias linked to multiple accounts. | No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM. | Yes | | issuerName | string | Conditional. This is the issuer name of recipient’s card.
This field is required if recipientPrimaryAccountNumber is present in request | No | | postalCode | string | Consumer’s postal code | No | | paymentType | string | Only “PAN” is accepted. Values such as “” or “pan” will be defaulted to “PAN”. All other values will be rejected. | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | originalAlias | string | Conditional. This attribute contains the original alias data, e.g. phone number, email address, etc. The data format should follow same as that of the attribute 'alias'.
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | consentDateTime | string | Date & time when consumer has provided their consent to issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | No | | originalAliasType | string | Conditional.
“01” – Phone number
“02” – email address
“03” – National ID
“04” – IBAN (International Bank Account Number).
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | recipientLastName | string | Last name of the consumer. | No | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | No | | recipientMiddleName | string | Consumer’s middle name. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer's card number. | No | #### UpdateAliasRequest-3 Schema Request payload for updating an alias of a consumer.

Note. This API only allows issuer to update data field(s) of one mapping of an alias to an account one at a time. To update data field(s) of
  • the mappings of multiple aliases linked to the same PAN; and/or
  • the mappings of one alias linked to multiple accounts
issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer's City | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
guid abcd12345678z01, alias 85291112222
guid abcd12345678z01, alias 85288881111.

For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
alias 85291112222, guid abcd12345678z01 for PAN1 (default)
alias 85291112222, guid abcd12345678z02 for PAN2
alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
CountryCountry CodeExamples
United States11650xxxxxxx
Russia77495xxxxxxx
United Kingdom444478xxxxxxxx
Singapore65659xxxxxxx
Hong Kong8528529xxxxxxx
Kenya254254701xxxxxx

If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
CountryExample
IrelandIE29AIBK93115212345678
where
Country Code: IE
Check digits: 29
Bank Identifier: AIBK
Branch Identifier: 931152
Account Number:12345678
| No | | country | string | Country code of the consumer as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | No | | newGuid | string | New unique identifier generated by issuer for a consumer if issuer would like to change the existing guid to a new value. | No | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Conditional. Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum.
This field is required if recipientPrimaryAccountNumber is present in request | No | | aliasType | string | “01” – Phone number
“02” – Email address
“03” – National ID
“04” – IBAN (International Bank Account Number) | No | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
Note. This attribute is only applicable to selected markets that allow to have one alias linked to multiple accounts. | No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM.
Note. This attribute is only applicable to selected markets. | No | | issuerName | string | Conditional. This is the issuer name of recipient’s card.
This field is required if recipientPrimaryAccountNumber is present in request | No | | postalCode | string | Consumer’s postal code | No | | paymentType | string | This attribute to accept paymentType as “PAN” | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | originalAlias | string | Conditional. This attribute contains the original alias data, e.g. phone number, email address, etc. The data format should follow same as that of the attribute 'alias'.
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | consentDateTime | string | Date & time when consumer has provided their consent to issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | No | | originalAliasType | string | Conditional.
“01” – Phone number
“02” – email address
“03” – National ID
“04” – IBAN (International Bank Account Number).
Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | recipientLastName | string | Last name of the consumer. | No | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | No | | recipientMiddleName | string | Consumer’s middle name. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer's card number. | No | #### _links Schema This contains the navigation url links of the report, i.e. 'self', 'first', 'next'(if applicable),'previous'(if applicable),'last'(if applicable). | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | last | string | This attribute is the url to retrieve the content of last page of the report. | No | | next | string | This attribute is the url to retrieve the content of previous page of the report if available. | No | | self | string | This attribute is the url to retrieve the content of current page of the report. | No | | first | string | This attribute is the url to retrieve the content of first page of the report. | No | | previous | string | This attribute is the url to retrieve the content of previous page of the report if available. | No | #### CashOutCardAcceptorAddressResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Recipient may replace this field with the city name of merchant. Visa settlement reports would contain the value provided by recipient. | Yes | | country | string | Conditional. Recipient may replace this field with the country code of the merchant, if the country code of recipient is different from originator. Visa settlement reports would contain the value provided by recipient. | Yes | #### MultiPullFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

Refer to Network ID

Note:
This field is returned only if it is anything other than networkId value 2.

Supported only in US for domestic transactions. | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### ErrorResponseV2 Schema Error response data. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | code | string | Error code of the unexpected error. | No | | reason | string | Reason of the unexpected error. | No | | message | string | Error description of the unexpected error. | No | #### GenerateReportRequest-1 Schema Request payload data to generate a report. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | Specify the type of alias records to be contained in the report.
Valid values are CONSUMER, MERCHANT and AGENT. | Yes | | limit | string | Maximum number of records to be contained in each page of the report.
Default is set to a maximum of 20,000 records per page of a report.
Minimum value is 1, Maximum value is 20,000. | No | | status | string | If not provided, default report contains alias records with all valid status, i.e.
Consumer alias report will contain 'ACTIVE','INACTIVE' and 'DISABLED' records
Merchant alias report will contain 'ACTIVE' and 'DISABLED' records
Agent alias report will contain 'ACTIVE' and 'DISABLED' records.
Valid values for status are 'ACTIVE', 'INACTIVE' and 'DISABLED'. | No | | reportStartDate | string | The start date of a report. Follows ISO 8601, date format YYYY-MM-DD. Example: 2019-01-01.
If not set, it will be default to the previous date (T-1). | No | #### CashOutPushPaymentPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | Transaction amount in merchant currency. | Yes | | senderName | string | Please use consumer name to populate this field. If consumer name is greater than 30 characters, use first 30 characteres. The name must be populated using the Roman, i.e. English character set. | Yes | | acquiringBin | string | BIN number identifies the originator of cash-out transaction. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | | Yes | | senderReference | string | A reference number unique to the merchant. Field can be left blank. | No | | acquirerCountryCode | string | Use a 3-digit numeric country code for the country where the Visa Direct solution is registered. This must match the information provided during program enrollment. Refer to [ISO Codes](/request_response_codes#iso_country_codes). | Yes | | senderAccountNumber | string | Populate with consumer PAN. If the consumer PAN is not populated or is not valid or contains extra spaces, VisaNet will reject the transaction with reject code 494 (Field or data missing or invalid) | Yes | | merchantCategoryCode | string | Numeric only. Originators should populate 6012. If this field is not populated by the originator, it will automatically be set to the MCC value indicated during the API onboarding process. Recipient should populate the MCC of the merchant in the response message. | Yes | | businessApplicationId | string | Use CO (cash-out). This field is populated with business application identifier for the transaction. Refer to [businessApplicationId](/request_response_codes#businessApplicationId) codes | Yes | | systemsTraceAuditNumber | string | Numeric only. It is a key data element used to match a response to its request or to match a message to others for a given transaction. The value assigned to the original request should appear in all subsequent messages for that transaction | Yes | | transactionCurrencyCode | string | The code in this field must always reflect the currency associated to the amount in field Amount. Use a 3-digit numeric currency code for currency. Refer to [ISO Codes](/request_response_codes#currency_codes). | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | The date and time the transaction takes place, expressed in the local date and time of the originator. | Yes | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. It is recommended that the client populate ydddhhnnnnnn value in this field. | Yes | | recipientPrimaryAccountNumber | string | Consumer PAN. 16-digit PAN as provided by the consumer to merchant. | Yes | #### ReverseFundsTransactionPostResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

Refer to Network ID

Note:
This field is returned only if it is anything other than networkId value 2.

Supported only in US for domestic transactions. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

Refer to actionCode
Note: The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

Refer to responseCode
Note: The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | supplementalData | { **"dcapIndicator"**: string } | This field will contain supplemental values for a transaction. | No | | customerReference | string | This field contains a value that identifies the customer.
This field needs to be populated for Argentina domestic purchase transactions where businessApplicationId is "PS". | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction.
Note:transactionIdentifier is a Visa generated field that client receives in the response message.
Note:As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconcilation. | Yes | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

This field will not be sent in the response if the transaction is ineligible for token services. | No | | merchantVolumeIndicator | integer | Merchant Volume Indicator to identify Nano/micro merchants (Peru market) Values: "51" (Micromerchant), "52" (Nanomerchant). | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions, where businessApplicationId is "PS", this field contains the customer’s VAT registration number for tax identification | No | #### QueryTransactionResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | This is the transaction amount expressed in U.S. Dollars. Derived by Visa. Depending on when the transaction is processed the amount field may not be present for upto 2 hours.
Note: This field will not be present when requestType is 02 or 03. | No | | cardType | string | Product type of the card on which the transaction is performed.
Valid Values include*
Credit
Debit
Prepaid.
Note: This field will not be present when requestType is 02 or 03. | No | | networkId | string | Network ID on which the transaction was performed.
Takes the format of 000x where x is a number.
Valid Values include*
0002 - Visa/PLUS
0016 - Maestro
0003 - Interlink
0008,0010,0011,0012,0015 - Star | No | | actionCode | string | The results of the transaction request
Refer to actionCode
Note: The VisaNet Response Code for the transaction | Yes | | reasonCode | string | The reason code description contains the reason explaining:
  • An acquirer-generated advice, reversal, cancellation, adjustment, chargeback (validation request or advice).
  • A chargeback reversal, representment (validation request or advice).
    • etc.
    Note: This field will not be present when requestType is 02 or 03. | No | | statusCode | string | Specifies status of the transaction processing.
    Valid values are
    • COMPLETED - Transaction was processed by Visa
    • IN_PROGRESS - Transaction is in progress, being processed by Visa
    • FAILED - Transaction was received and rejected by Visa
    • PENDING - Transaction is pending for processing by Visa
    • CANCELLED - Transaction was cancelled as requested by the originating acquirer
    | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | approvalCode | string | The authorization code from the issuer. A code provided by the issuer (or VIP STIP) when a transaction is approved, or a no reason to decline code is provided. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string } | | No | | chipCardData | string | A blob containing the Chip card data in TLV format
    *Example:* `"8201495F2A0201245F34010182021C008407A0000000031010950580000000009A031102249B0268009C01009F02060000000000009F03060000000000009F0607A00000000310109F0802008C9F0902008C9F100706010A039000009F1A0201249F2608423158936ED6C38F9F2701809F3303E0B0C89F34034103029F3501229F360200019F3704ACAC66E89F5800DF0100DF0200DF0400"` | No | | dafIndicator | string | An authentication program indicator to identify transactions qualified by the Digital Authentication Framework for requests containing a CAVV and/or TAVV.
    Possible values are true or false | No | | persistentFX | { **"exchangeRate"**: number (bigDecimal), **"visaRateTableId"**: string, **"visaRateProvider"**: string } | | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.
    Refer to responseCode
    Note: The VisaNet Response Source for the transaction. When the requestType is 02 or 03, this field may not be present in all responses. | Yes | | dcapIndicator | string | Contains an indicator that identifies if the merchant has used the eligible authentication or data sharing method and provided the required data elements.
    The valid value is 1 (VDCAP). | No | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

    Refer to cavvResultCode | No | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode | No | | feeProgramDesc | string | Short text description of the Acquirer IRF (Interchange Reimbursement Fee) indicator. (Interchange fees are paid by issuers and acquirers to each other for transactions entered into interchange and their reversals).
    Note: This field will not be present when requestType is 02 or 03. | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Note: Applicable only for Top Up Transactions | No | | processingDate | string (DD-MM-YYYY) | The date on which VisaNet created the log (record).
    Note: This field will not be present when requestType is 02 or 03. | No | | settlementDate | string (DD-MM-YYYY) | This field contains the settlement date for the transaction processed by VisaNet.
    Note: This field will not be present when requestType is 02 or 03. | No | | settlementInfo | { **"settlementAmount"**: number (bigDecimal), **"settlementCurrencyCode"**: integer, **"settlementConversionRate"**: number (bigDecimal) } | Note:
    get the value in decimal values by combining rate value with rate decimal positions | No | | settlementTime | string (HH24:MM:SS) | This field contains the settlement time for the transaction processed by VisaNet.
    Note: The exact time of settlement may vary and is indicative only. | No | | reasonCodeValue | string | While reasonCode property explains the reason in details, reasonCodeValue property is a four digit number that corelates to reasonCode.
    Valid Values include*
    0000 - NOT APPLICABLE
    0083 - FRAUD; CARD ABSENT ENVIRONMENT.
    Note: This field will not be present when requestType is 02 or 03. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"senderReference"**: string, **"customerReference"**: string, **"merchantReference"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string, **"senderIdentificationNumberBusiness"**: string, **"senderIdentificationNumberIndividual"**: string } | | No | | transactionDate | string (DD-MM-YYYY) | The transaction date in GMT time at which the transaction was received and processed by VisaNet. | Yes | | transactionTime | string (HH24:MM:SS) | The time the transaction was submitted to VisaNet. | Yes | | transactionType | string | Identifies the type of transaction originally sent
    Valid Values include*:
    CRED VOUCHER
    CRED REVERSAL
    CRED CHGBK
    CRED CHGBK REVERSAL
    SALES DRAFT
    SALES CHGBK
    SALES REVERSAL
    CASH DISBURSEMT
    CASH CHGBK.
    Note: This field will not be present when requestType is 02 or 03. | Yes | | motoECIIndicator | string | Identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet) or the type of mail or telephone order. Acquirers supply indicator values, which V.I.P. forwards in requests and advices to issuers that have successfully tested to receive them. The subfield is dropped if issuers have not successfully completed testing or choose not to receive it.

    Refer to Moto ECI Codes | No | | rejectReasonCode | integer | This field contains reject reason code if the the transaction was rejected by VisaNet.
    A positive number not greater than 9999. | No | | rejectReasonText | string | This field contains reject reason text if the transaction was rejected by VisaNet. | No | | customerReference | string | Conditional

    This field contains a value that identifies the customer. | No | | originalActionCode | string | The response code received from the recipient issuer after sending the original OCT request once the hold time expires for that transaction.
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | accountNumberMasked | string | Contains the masked PAN number. Populated from the primary account number (PAN) contained in the original authorization request. | No | | feeProgramIndicator | string | This field contains an interchange reimbursement fee program indicator (FPI), which is used in assessing the fee amount applied to financial transactions that were originally sent. | No | | transactionStateCode | string | Code explaining the state of the transaction.
    Note: This field will not be present when requestType is 02 or 03. | No | | businessApplicationId | string | Business Application ID indicates to the type of Transaction that has taken place.
    Valid Values include*
    • AA - Account to Account
    • BB - Business to Business
    • BI - Money Transfer (bank-initiated)
    • CP - Card Bill Payment

    For more information visit Visa Developer Platform Documentation | No | | riskAssessmentResults | { **"exemptionReasonCode"**: [ string ], **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | This object is present in the response only if the issuer supports SCA exemptions. | No | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | string | The VisaNet reference number for the transaction. This is the same transactionIdentifier previously received in the response for PullFunds, PushFunds or ReverseFunds transaction API calls. | Yes | | currencyConversionRate | string | Currency conversion rate taken place at Acquirer's end.
    Note: This field will not be present when requestType is 02 or 03. | No | | reimbursementAttribute | string | Conditional
    If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
    Please reach out to your Visa representative for details. | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | systemsTraceAuditNumber | string | A number assigned by the message initiator that uniquely identifies a transaction. This is the same as systemsTraceAuditNumber previously sent in the request for the PullFunds, PushFunds or ReverseFunds transaction API calls. | Yes | | transactionCurrencyCode | string | 3-character numeric currency code of the transaction. | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. This is the same as retrievalReferenceNumber previously sent in the request for PullFunds, PushFunds or ReverseFunds transaction API calls. | Yes | | integratedCircuitCardData | string | A blob containing the Chip card data in TLV format.
    *Example:* `"8201495F2A0201245F34010182021C008407A0000000031010950580000000009A031102249B0268009C01009F02060000000000009F03060000000000009F0607A00000000310109F0802008C9F0902008C9F100706010A039000009F1A0201249F2608423158936ED6C38F9F2701809F3303E0B0C89F34034103029F3501229F360200019F3704ACAC66E89F5800DF0100DF0200DF0400"` | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | addressVerificationResults | string | Results of the Address Verification Service (AVS) validation for the Primary Account Number.
    Refer to addressVerificationResults
    *Example:* `"string"` | No | | amountInTransactionCurrency | string | This is the transaction amount in original transaction currency. | No | | productIdentifierPlatformCode | string | Product Identifier Platform Code.
    Valid Values include*
    BZ - Business
    CN - Consumer
    CO - Commercial
    GV - Government.
    Note: This field will not be present when requestType is 02 or 03. | No | | approvedAmountInTransactionCurrency | double | This field will be present in a partially approved AFT transaction. It will contain the amount approved by the card issuer, and is represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | senderIdentificationNumberIndividual | string | Conditional

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer's VAT registration number for tax identification. | No | | masterCardElectronicCommerceIndicators | string | This field contains the security-level indicator for Mastercard issuer-authenticated transactions. | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation)

    Note: Supported only in US for CPS (Custom Payment Service).

    This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.

    Please reach out to your Visa representative for details. | No | #### ReverseFundsTransactionPostResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction.
    Note:transactionIdentifier is a Visa generated field that client receives in the response message.
    Note:As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconcilation. | Yes | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### ReverseFundsTransactionPostResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | customerReference | string | This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic purchase transactions where businessApplicationId is "PS". | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction.
    Note:transactionIdentifier is a Visa generated field that client receives in the response message.
    Note:As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconcilation. | Yes | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions, where businessApplicationId is "PS", this field contains the customer’s VAT registration number for tax identification | No | #### GetAliasResponse Schema Response data when a consumer alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | Conditional. This field will not be returned if the object 'aliases' presents.
    This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | No | | status | string | The status of an alias. For consumer alias, this value can be 'INACTIVE', 'ACTIVE', or 'DISABLED'. For merchant/agent alias, this value can be 'ACTIVE' or 'DISABLED'.
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | aliases | { **"alias"**: string, **"aliasType"**: string, **"isDefault"**: string } | | No | | country | string | Consumer’s country code as defined by ISO 3166. | Yes | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum | Yes | | aliasType | string | Conditional. This field will not be returned if the object 'aliases' presents.
    “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | No | | expiryDate | string | Card expiration date. | Yes | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Consumer’s postal code | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss.
    It is in Coordinated Universal Time (UTC). | No | | recipientLastName | string | Last name of the consumer. | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | Yes | | recipientMiddleName | string | Consumer’s middle name. | No | | statusChangeDateTime | string | The date and time when the status of an alias is changed. It is in Coordinated Universal Time (UTC).
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer’s card number | Yes | #### UpdateMerchantAliasRequest-1 Schema Request payload for updating merchant or agent alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Merchant or agent city. | No | | email | string | Merchant or agent email address. | No | | phone | string | Merchant or agent phone number. | No | | aliasId | string | This attribute is used by acquirer to uniquely identify their merchant or agent. | Yes | | country | string | Merchant or agent country code as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | No | | aliasType | string | 01 – Phone number
    02 – Email address
    03 – USSD Payment ID
    04 – BID (Bank Identification Number)
    05 – National ID
    06 – Custom
    Null – Should start with visa assigned USSD Payment ID | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | No | | postalCode | string | Merchant or agent postal code. | No | | isAgentAlias | string | Optional and applicable for agent alias use only. If set as 'Y', agent alias to be updated. | No | | recipientName | string | Merchant or agent name. | No | | convenienceFeeAmount | string | The convenience fee of a fixed amount. Applicable only for merchant alias. | No | | merchantCategoryCode | string | Merchant Category Code. Numeric only. | No | | payloadFormatIndicator | string | Defines the format of the merchant data payload. Payload Format Indicator must be set to '01' as per EMVCo Merchant Presented QR specifications. | No | | pointOfInitiationMethod | string | In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st character
    '1' = QR
    '2' = BLE
    '3' = NFC
    '4' - '9' = Reserved for Future Use
    2nd character
    '1' = Static
    '2' = Dynamic
    '3' - '9' = Reserved for Future Use.
    Example: '11' indicates QR static code, '12' indicates QR dynamic code. | No | | transactionCurrencyCode | string | As defined by ISO 4217. This is the transaction currency code that a merchant can accept for payment. 3-digit numeric presentation of the currency is recommended to be used if alias may be used for QR. | No | | convenienceFeePercentage | string | Applicable only for merchant alias. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). | No | | tipConvenienceFeeIndicator | string | Tip or Convenience Fee Indicator. This shall contains a value of '01', '02' or '03' as per EMVCo Merchant Presented QR specifications. Applicable only for merchant alias. | No | #### AliasResponse Schema Response if a recipient is successfully created,updated or deleted. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | GUID of the consumer of issuer is returned if alias is created/updated/deleted successfully. | No | #### AliasResolveResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | url | string | Optional. An URL of a landing page that contains participating issuers will be returned to originator if an alias cannot be found in Visa Alias Directory and HTTP status code = 404. Originator can notify unregistered recipient with this URL so that he/she can select preferred issuer for alias registration.
    Note:This attribute is only applicable to selective markets, originator will receive this URL instead of error JSON response for processing if HTTP status code = 404. Contact Visa's representative for details. | No | | city | string | City of the recipient. Recipient can be a consumer, merchant or agent. | No | | country | string | Country code of the recipient. As defined by ISO 3166. For aliases created after the September 2023 release, country will be returned in ISO3166-Alpha3 format for resolve response. For aliases created before the September 2023 release, country will be returned in whatever format was provided at the time of the Alias creation. | Yes | | cardType | string | Conditional. Card type description. Reference to Field 62.23 — Product ID of available card products. e.g. Visa Platinum. Only applicable if businessApplicationId = “PP” or “CI” | No | | issuerName | string | Conditional. This is the issuer name of recipient’s card. Only applicable if businessApplicationId = “PP” or “CI” | No | | postalCode | string | Postal Code of the recipient. Recipient can be a consumer, merchant or agent. | No | | recipientName | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer name, merchant name or agent name. Regarding consumer name, this is composed of consumer’s first, middle and last name. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | Yes | | accountLookUpInfo | { **"visaNetworkInfo"**: [ { **"issuerName"**: string, **"cardTypeCode"**: string, **"tokenIndicator"**: string, **"geoRestrictionInd"**: string, **"fastFundsIndicator"**: string, **"billingCurrencyCode"**: integer, **"cardIssuerCountryCode"**: string, **"pushFundsBlockIndicator"**: string, **"onlineGambingBlockIndicator"**: string, **"billingCurrencyCodeMinorDigits"**: string } ] } | | No | | recipientNameLocal | string | This attribute contains the consumer name in the local language, if one is defined in the consumer's profile. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | No | | convenienceFeeAmount | string | Conditional. The convenience fee of a fixed amount. The format of the amount is the same as defined in tag 54. Convenience amount as provided by merchant shall be passed in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | merchantCategoryCode | string | Conditional. Merchant Category Code. This attribute will only be returned if businessApplicationId=MP, CO | No | | pointOfInitiationMethod | string | Conditional. In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st Character:
    “1” = QR
    “2” = BLE
    “3” = NFC
    “4”-“9” = Reserved for future use

    2nd Character:
    “1” = Static
    “2” = Dynamic
    “3”-“9” = Reserved for future use

    Example: “11” indicates QR static code, “12” indicates QR dynamic code
    This attribute will only be returned if businessApplicationId=MP, CO | No | | transactionCurrencyCode | string | Conditional. This is the transaction currency code that a merchant can accept for payment. This attribute will only be returned if businessApplicationId=MP, CO. As defined by ISO 4217. | No | | convenienceFeePercentage | string | Conditional. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). Originators are required to derive the convenience fee amount and shall pass it in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | tipConvenienceFeeIndicator | string | Conditional. Tip or Convenience Fee Indicator. This attribute will only be returned if businessApplicationId=MP. | No | | recipientPrimaryAccountNumber | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer card number, mVisa merchant ID (16-digit) or mVisa agent ID (16-digit). | Yes | #### AdjustFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The amount of the transaction, inclusive of all fees assessed for the transaction, including currency conversion fees.
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | networkId | number | Network identifier | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | tokenData | object | Token data for payment | No | | acquiringBin | number | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string, **"paymentFacilitator"**: { **"additionalAcceptor"**: { **"foreignRetailerIndicator"**: string,
    **Available values:** "A", "B" } } } | | Yes | | recipientName | string | Recipient name | No | | cardExpiryDate | string |
    Recommended Format: YYYY-MM
    The expiration date for the sender's Visa account number in primaryAccountNumber. | No | | cardProductCode | string | Used to identify the specific card product for the issuer. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | schemeIdentifier | string | Scheme identifier | No | | senderPostalCode | string | Sender postal code | No | | customerReference | string | Conditional.

    This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | merchantReference | string | Conditional.

    This field contains the merchant account key value for Argentina domestic purchase (POS) transactions.
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | messageReasonCode | number | Message Reason Code: 2140 for AFT and 2150 for OCT. To identify advice type for issuers.
    Message Reason Code: 5120 for OCT Debit Adjustments to reverse Sales Tax Rebates (Value-added tax) along with businessApplicationId field set to the value 'FD'. | No | | pointOfServiceData | { **"panEntryMode"**: number, **"posConditionCode"**: number, **"specialConditionIndicatorMerchant"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. This code identifies the currency of the transaction amount sent in the amount field.
    This field will be deprecated. Please use the replacement field transactionCurrencyCode instead. | Yes | | acquirerCountryCode | number | Use a three digit numeric country code for the country of the BIN under which your Visa Direct program is registered. | Yes | | feeProgramIndicator | string | Fee program indicator | No | | transactionTypeCode | number | A 2-digit code identifying the transaction type. It must be 02 (Adjustment—Debit) or 22 (Adjustment—Credit).
    Note: For JSON format request, 02 is not legal for integer data type, please use 2 instead or pass “02” as a string. (AFT Debit adjustment is not available.) | No | | merchantCategoryCode | number | Contains a code describing the merchant's type of business product or service, also known as the merchant category code (MCC). These codes are based on the Merchant Classification Code Guideline available from the Bank Card Division of the ABA. Clients should send the same merchantCategoryCode that was submitted in the PullFundsTransactions | No | | originalDataElements | object | Original data elements | No | | primaryAccountNumber | string | Conditional

    This field contains a number identifying the customer account which could be a PAN or a token. | No | | senderCardExpiryDate | string |
    Recommended Format: YYYY-MM
    The expiration date for the sender's Visa account number in senderPrimaryAccountNumber.
    This field will be deprecated. Please use the replacement field cardExpiryDate instead. | No | | tokenAssuranceMethod | string | This field contains different category value to determine the Risk Score associated with the token and transaction. | No | | businessApplicationId | string | Identifies the Visa Direct use case required for processing. This must match the value provided in the request of PullFundsTransactions.
    For Argentina domestic purchase transactions the value should be "PS". | Yes | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | number | Clients shall send the Visa transaction identifier returned in the response of PullFundsTransactions. Note: This value for the purpose of credit adjustment must be same as the original request. | Yes | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | digitalWalletProviderId | string | Used to identify the digital wallet provider. V.I.P. does not edit the field; it also does not send it to the issuer processor nor does it return this field in the response. | No | | merchantPseudoAbaNumber | string | Merchant pseudo ABA number | No | | systemsTraceAuditNumber | number | This field contains a number assigned by the merchant, service provider or acquirer that uniquely identifies a cardholder transaction and all message types (also known as system transactions) that comprise it per individual program rules. A unique value should be used for each API invocation. Note: This value for the purpose of credit adjustment must be different from the original request. | Yes | | transactionCurrencyCode | string | Conditional

    Use a 3-character alpha or numeric currency code for currency of the original transaction.

    Refer to ISO Codes | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the Adjustment transaction is submitted.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2020-05-21T13:30:00 | Yes | | nationalReimbursementFee | double | National reimbursement fee | No | | pointOfServiceCapability | object | Point of service capability data | No | | retrievalReferenceNumber | number | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Recommended format: ydddhhnnnnnn. The first four digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year), hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed, nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. A unique value should be used for each API invocation. Note: This value for the purpose of credit adjustment must be different from the original request. | Yes | | merchantVerificationValue | object | Merchant verification value | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | optionalResponseParameters | string | Optional response parameters | No | | senderPrimaryAccountNumber | string | This field contains a number identifying the customer account which could be a PAN or a token.
    This field will be deprecated. Please use the replacement field primaryAccountNumber instead. | No | | settlementServiceIndicator | number | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | rewardProgramIdentificationCode | string | Used to identify the reward program. | No | | senderPaymentCredentialReference | { **"type"**: string,
    **Available values:** "PCI_TOKEN_REFID", "PAYMENT_CREDENTIAL_ID", **"value"**: string, **"merchantId"**: string } | Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID Conditional Only one of 'senderPrimaryAccountNumber' and 'senderPaymentCredentialReference' is provided in a request | No | | dynamicCurrencyConversionIndicator | string | Used to indicate if the merchant or the ATM acquirer has performed Dynamic Currency Conversion (DCC). | No | | senderIdentificationNumberIndividual | string | Conditional.

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | recipientIdentificationNumberBusiness | string | Conditional.

    For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN).
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee. Please reach out to your Visa representative for details. | No | #### MultiPullFundsTransactionGetResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response_code
    Note: : The VisaNet Response Source for the transaction | Yes | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

    Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z
    Note: Remove "000Z" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request. | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | Conditional
    If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
    Please reach out to your Visa representative for details. | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).

    Note:Supported only in US for CPS (Custom Payment Service).

    Please reach out to your Visa representative for details. | No | #### MerchantCardAcceptorAddress Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Originator can populate this field with value captured from merchant information display. If manual entered transaction then populate default value of 'mVisa payment'. | Yes | | country | string | Originator can include the 2-character alpha country code of the merchant captured from the merchant information display | Yes | #### MultiPullFundsTransactionGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response_code
    Note: : The VisaNet Response Source for the transaction | Yes | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

    Refer to cavvResultCode | No | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode
    *Example:* `"string"` | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z
    Note: Remove "000Z" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request. | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | Conditional
    If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
    Please reach out to your Visa representative for details. | No | | enablerVerificationValue | binary | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).

    Note:Supported only in US for CPS (Custom Payment Service).

    Please reach out to your Visa representative for details. | No | #### _links-1 Schema This contains the navigation url links of the report, i.e. 'self', 'first', 'next'(if applicable),'previous'(if applicable),'last'(if applicable). | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | last | string | This attribute is the url to retrieve the content of last page of the report. | No | | next | string | This attribute is the url to retrieve the content of previous page of the report if available. | No | | self | string | This attribute is the url to retrieve the content of current page of the report. | No | | first | string | This attribute is the url to retrieve the content of first page of the report. | No | | previous | string | This attribute is the url to retrieve the content of previous page of the report if available. | No | #### MerchantPushPaymentResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | Contains a code that defines the response to a request.
    Refer to actionCode | Yes | | approvalCode | string | Conditional. Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipients maintain uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | It is optional for recipient to send card acceptor field in the response. However, if it is in the response, all merchant name, city and country need to be there. | No | | responseCode | string | It is added by VisaNet and contains the response source/reason code that identifies the source of the actionCode response decision. | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | Required when API response times out. | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transaction. | No | | memberSuppliedIRF | string | Optional field which contains interchange fee provided by recipient and its only relevant for LAC regional markets. List of Countries supported:
    1. Costa Rica
    2. Dominican Republican
    3. Venezuela
    4. Guatemala | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | | No | | feeProgramIndicator | string | Optional field which may be populated by recipient where applicable. | No | | merchantCategoryCode | string | Numeric only. Recipient should populate the MCC of the merchant in the response message. | No | | transmissionDateTime | dateTime | The value in response must match the value in the request. | Yes | | transactionIdentifier | string | It is added by VisaNet. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | reimbursementAttribute | string | This field contains a code that identifies the applicable interchange reimbursement fee for the transaction. Please contact your Regional Visa Client Support Services Representative to identify the value that you should be using. | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. Value will be the same as what has been provided in the request. | Yes | | argentinaReimbursementFee | double | Optional, this field contains the Argentina member supplied reimbursement fee. If present, populate 0 | No | | merchantVerificationValue | string | Recipient are expected to populate the Merchant Verification Value used to identify merchants that participate in a variety of programs in this field The valid values are 0-9 and A-F. These values are hexadecimal. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification, then this field to be populated for Argentina domestic transaction. | No | #### MultiReverseFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### UpdateAliasRequest Schema Request payload for updating an alias of a consumer.

    Note. This API only allows issuer to update data field(s) of one mapping of an alias to an account one at a time. To update data field(s) of
    • the mappings of multiple aliases linked to the same PAN; and/or
    • the mappings of one alias linked to multiple accounts
    issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer's City | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | No | | country | string | Country code of the consumer as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | No | | newGuid | string | New unique identifier generated by issuer for a consumer if issuer would like to change the existing guid to a new value. | No | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Conditional. Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum.
    This field is required if recipientPrimaryAccountNumber is present in request | No | | aliasType | string | “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | No | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
    Note. This attribute is only applicable to selected markets that allow to have one alias linked to multiple accounts. | No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM. | Yes | | issuerName | string | Conditional. This is the issuer name of recipient’s card.
    This field is required if recipientPrimaryAccountNumber is present in request | No | | postalCode | string | Consumer’s postal code | No | | paymentType | string | This attribute to accept paymentType as “PAN” | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | originalAlias | string | Conditional. This attribute contains the original alias data, e.g. phone number, email address, etc. The data format should follow same as that of the attribute 'alias'.
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | consentDateTime | string | Date & time when consumer has provided their consent to issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | No | | originalAliasType | string | Conditional.
    “01” – Phone number
    “02” – email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number).
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | recipientLastName | string | Last name of the consumer. | No | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | No | | recipientMiddleName | string | Consumer’s middle name. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer's card number. | No | #### content Schema Depending on the selected type of alias reports, this contains a list of consumer, merchant or agent alias records. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | Conditional. Only applicable for consumer alias report. This attribute is uniquely used by issuer to identify their cardholders (i.e. consumer). | No | | status | string | The status of an alias.
    For consumer alias, this value can be 'ACTIVE', 'DISABLED' or 'INACTIVE'.
    For merchant/agent alias, this value can be 'ACTIVE' or 'DISABLED'. | No | | aliasId | string | Conditional. Only applicable for merchant/agent alias report. This attribute is used by acquirer to uniquely identify their merchant or agent. | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | No | | statusChangeDateTime | string | The date and time when the status of an alias is changed. It is in Coordinated Universal Time (UTC). | No | #### MultiReverseFundsTransactionGetResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | feeProgramIndicator | object | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52:000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### MultiReverseFundsTransactionGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | feeProgramIndicator | object | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52:000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | enablerVerificationValue | binary | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### MerchandiseReturnReversalTransactionResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | It contains a code that defines the response to a request.
    Refer to actionCode | Yes | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.Refer to The VisaNet Response Source for the transaction | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | required when call times out | No | | feeProgramIndicator | string | Optional field which may be populated by recipient where applicable. | No | | transmissionDateTime | dateTime | Transmission date and time | Yes | | transactionIdentifier | string | It contains a right-justified, VisaNet generated Transaction Identifier (TID). | Yes | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | merchantVerificationValue | string (hexbinary) | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### AliasInquiryResponse Schema Alias Inquiry Response Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | details | [ { **"alias"**: string, **"aliasType"**: string, **"paymentInstrOwner"**: string,
    **Available values:** "REQUESTOR", "OTHER", **"paymentInstrTypes"**: [ string ] } ] | | No | | summary | { **"aliasesFound"**: integer, **"aliasesTotal"**: integer, **"aliasesNotFound"**: integer } | | Yes | #### PersonToMerchantAdviceRequest Schema Request body for Receive Person-to-Merchant Advice API | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | refId | string | Conditional. This field is sent if it is reflected in the merchant information display. It will otherwise be sent as NULL if it is not populated. | No | | billId | string | Conditional. This is the invoice number or some other reference for billing purposes. This field will be sent as NULL if it is not populated. | No | | messageType | string | Possible values based on Message Type Identifier are:
    • 0200 : 'Recipient Timeout'
    • 0220 : 'Advice' (STIP decline advice)
    • 0210 : 'Reject' (VIP reject)
    | Yes | | billIdFormat | string | Conditional. Populate 0 (Primary ID, as defined by mVisa)
    This field will be sent as NULL if it is not populated. | No | | responseCode | string | Contains a code (also known as 'Action Code') that defines the response to a request. Refer to actionCode. This field is to be sent as NULL when messageType is 0200 - Recipient Timeout. | No | | originatorBIN | string | This BIN number identifies the originator of merchant payment transaction. | Yes | | rejectionCode | string | Only populated if Advice message type is ‘Reject’. This field contains the VisaNet rejection code. | No | | authIdResponse | string | Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipient maintains uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. This field is to be sent as NULL if it is not populated. | No | | encConsumerPAN | string | Consumer PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | encMerchantPAN | string | Merchant PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | encConsumerName | string | Consumer name. If consumer name is greater than 30 characters, then only first 30 characters will be expected. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). | Yes | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionAmount | string | Transaction amount in merchant currency. The value in this field includes tip or convenience fees, if applicable. | Yes | | visaTransactionId | string | Numeric. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | localTransactionDate | string | It contains the local month and day on which the transaction was originated. The date is in mmdd format. | Yes | | localTransactionTime | string | The time the transaction takes place, expressed in the local time of the originator. The time is in hhmmss format. | Yes | | transactionFeeAmount | string | Conditional. In certain case the merchant display information could contain convenience fee applicable to the transaction. Originators are required to populate convenience fee amount in this field, if presented by merchant. This field will be sent as NULL if it is not populated. | No | | transmissionDateTime | string | The date and time the request was submitted to Visa. Format: MMDDhhmmss. | Yes | | originatorCountryCode | string | A 3-digit ISO-4217 code that identifies the country of the originating BIN.
    Refer to ISO codes. | Yes | | systemTraceAuditNumber | string | Numeric. It is a key data element used to match a response to its request or to match a message to others for a given transaction. | Yes | | velocityLimitIndicator | string | Conditional. This field contains the velocity limit related information that Acquirer can use in making the authorization decision:
    • 1 = 1-day count or amount exceeded.
    • 2 = 7-day count or amount exceeded.
    • 3 = 30-day count or amount exceeded.
    The field is populated with priority of 1, 2 and then 3.
    This field is sent if recipient has opted for VisaNet to forward them the OCT when a velocity limit has been exceeded.
    This field will be sent as NULL if it is not populated. | No | | transactionCurrencyCode | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the transactionAmount field. | Yes | | decimalPositionIndicator | string | Indicates the number of decimal positions following the amount field. This field is to be sent as NULL if it is not populated. | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | Numeric. It is a key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. The format is recommended to be ydddhhnnnnnn. | Yes | #### ReverseFundsTransactionGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | object | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52:000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### MultiPullFundsTransactionRequests-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | cavv | string | The Cardholder Authentication Verification Value (CAVV) is a value generated by an Access Control Server (ACS) and signed by the Issuer using account and password information of cardholders registered for the Verified by Visa program. This field should be in hexabinary format. | No | | amount | double | The amount of the transaction, inclusive of all fees you assess for the transaction, including currency conversion fees. If the originator is populating the surcharge or foreignExchangeFeeTransaction field, they must be included in the amount field.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | pinData | { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | When present, this field contains sender's city | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | cardCvv2Value | string | The cardCvv2Value provided by the account holder for the senderPrimaryAccountNumber in the request. | No | | senderAddress | string | When present, this field contains sender's Address | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | recipientState | string | Required if RecipientCountryCode is either 124(CAN) or 840(USA) | No | | senderLastName | string | This field contains sender's last name | No | | senderFirstName | string | This field contains sender's first name | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | When present, this field contains sender's state code | No | | senderPostalCode | string | When present, this field contains the sender's postal code | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated.
    Note: Message reason code and POS Environment fields are mutually exclusive.

    Refer to Meassage Reason Codes | No | | recipientLastName | string | When present, this field contains recipient's last name | No | | senderCountryCode | string | when present, this field contains sender's country code

    Refer to ISO Codes | No | | sourceOfFundsCode | string | when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.

    Refer to sourceOfFundsCode codes | No | | magneticStripeData | { **"track1Data"**: string, **"track2Data"**: string } | | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
    Note: For a CardPresent Transactions, this field is required. | Yes | | recipientFirstName | string | When present, this field contains recipient's first name | No | | riskAssessmentData | { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | senderAccountNumber | string | When present, this field contains the sender's account number. This field is mandatory in cross-border AFTs it will contain the destination account number being funded with the AFT (e.g. IBAN number for loading a bank account, proprietary wallet number for loading a wallet, prepaid PAN number for loading a card, money transfer operator proprietary account number with acquirer for funding a money transfer). | No | | senderMiddleInitial | string | This field contains sender's middle initial | No | | recipientCountryCode | string | when present, this field contains recipient's country code

    Refer to ISO Codes | No | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber | Yes | | originalTransactionId | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated

    Note: Merchants must link the Merchant-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring, installment, and unscheduled COF), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | addressVerificationData | { **"street"**: string, **"postalCode"**: string } | Conditional
    Address verification is required for an AFT transaction to qualify for CPS. Either send the card’s postal code or full address.
    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Either the postalCode or full address of the card is required.
    Please reach out to your Visa representative for details. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format: ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

    hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
    Note:
    If a currency has one decimal place, the last digit of this field must be zero.
    If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator). Values in this field must be in the same currency and format as defined in the amount field. | No | | recipientIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)

    If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT

    This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transaction when businessApplicationId:PS | No | | recipientIdentificationNumberIndividual | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is an Individual (e.g. P2P payments)

    If recipientIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT
    | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

    Note:Supported only in US for CPS (Custom Payment Service).

    This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.
    Please reach out to your Visa representative for details. | No | #### MultiPullFundsTransactionRequests-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | cavv | string | The Cardholder Authentication Verification Value (CAVV) is a value generated by an Access Control Server (ACS) and signed by the Issuer using account and password information of cardholders registered for the Verified by Visa program. This field should be in hexabinary format. | No | | amount | double | The amount of the transaction, inclusive of all fees you assess for the transaction, including currency conversion fees. If the originator is populating the surcharge or foreignExchangeFeeTransaction field, they must be included in the amount field. | Yes | | pinData | { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | When present, this field contains sender's city | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | cardCvv2Value | string | The cardCvv2Value provided by the account holder for the senderPrimaryAccountNumber in the request. | No | | senderAddress | string | When present, this field contains sender's Address | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | recipientState | string | Required if RecipientCountryCode is either 124(CAN) or 840(USA) | No | | senderLastName | string | This field contains sender's last name | No | | senderFirstName | string | This field contains sender's first name | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | When present, this field contains sender's state code | No | | senderPostalCode | string | When present, this field contains the sender's postal code | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated.
    Note: Message reason code and POS Environment fields are mutually exclusive.

    Refer to Meassage Reason Codes | No | | recipientLastName | string | When present, this field contains recipient's last name | No | | senderCountryCode | string | when present, this field contains sender's country code

    Refer to ISO Codes | No | | sourceOfFundsCode | string | when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.

    Refer to sourceOfFundsCode codes | No | | magneticStripeData | { **"track1Data"**: string, **"track2Data"**: string } | | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
    Note: For a CardPresent Transactions, this field is required. | Yes | | recipientFirstName | string | When present, this field contains recipient's first name | No | | riskAssessmentData | { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | senderAccountNumber | string | When present, this field contains the sender's account number. This field is mandatory in cross-border AFTs it will contain the destination account number being funded with the AFT (e.g. IBAN number for loading a bank account, proprietary wallet number for loading a wallet, prepaid PAN number for loading a card, money transfer operator proprietary account number with acquirer for funding a money transfer). | No | | senderMiddleInitial | string | This field contains sender's middle initial | No | | recipientCountryCode | string | when present, this field contains recipient's country code

    Refer to ISO Codes | No | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber | Yes | | originalTransactionId | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated

    Note: Merchants must link the Merchant-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring, installment, and unscheduled COF), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial | No | | visaMerchantIdentifier | string | Visa Merchant Identifier | No | | addressVerificationData | { **"street"**: string, **"postalCode"**: string } | Conditional
    Address verification is required for an AFT transaction to qualify for CPS. Either send the card’s postal code or full address.
    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Either the postalCode or full address of the card is required.
    Please reach out to your Visa representative for details. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format: ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

    hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
    Note:
    If a currency has one decimal place, the last digit of this field must be zero.
    If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator). Values in this field must be in the same currency and format as defined in the amount field. | No | | recipientIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)

    If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT

    This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transaction when businessApplicationId:PS | No | | recipientIdentificationNumberIndividual | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is an Individual (e.g. P2P payments)

    If recipientIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT
    | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

    Note:Supported only in US for CPS (Custom Payment Service).

    This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.
    Please reach out to your Visa representative for details. | No | #### DeferredOCTAdviceRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | Amount in transaction currency. | Yes | | networkId | string | Network ID on which the transaction was performed.Takes the format of 000x where x is a number.Valid Values include*
    0002 - Visa/PLUS
    0016 - Maestro
    0003 - Interlink
    0008,0010,0011,0012,0015 - Star | No | | acquringBin | string | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. | No | | approvalCode | string | It contains the authorization code provided by the Issuer when a transaction is approved, if the approval code ISO field 38 is present in the 0210 response from Issuer, then Visa would populate the same value and send it in the advice. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"postalCode"**: string }, **"terminalId"**: string } | | No | | dateConversion | string (yyyy-MM-dd) | It contains the effective date of the conversion rate used to convert the transaction amount to the settlement amount. | No | | cardProductCode | string | Used to identify the specific card product. | No | | settlementAmount | string | This field contains the transaction amount converted to settlement currency. | No | | messageReasonCode | string | 4 digits message reason code to give processing intent:9052 - Confirmation Advice | No | | cardSequenceNumber | string | 3 digit number assigned to a card when two or more cards are associated with the same PAN. | No | | dateReconciliation | string (yyyy-MM-dd) | This contains the date on which the transactions were settled. | Yes | | originalActionCode | string | The response code received from the recipient issuer after sending the original OCT request once the hold time expires for that transaction. Refer to actionCode
    https://developer.visa.com/request_response_codes#action_code | Yes | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: string } | | No | | settlementConvRate | string | This field contains the rate used by VisaNet to convert the transaction amount to settlement amount. | No | | settlementCurrency | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the settlementAmount field. | No | | accountNumberMasked | string | Contains the masked PAN number. Populated from the primary account number (PAN) contained in the original authorization request. | Yes | | feeProgramIndicator | string | This field contains an interchange reimbursement fee program indicator (FPI), which is used in assessing the fee amount that was sent in the original request. | No | | transactionTypeCode | string | Processing code:
    26 - 'Original Credit' | Yes | | localTransactionDate | string | It contains the month and day on which the transaction was originated by the originator. The date is in mmdd format. | Yes | | localTransactionTime | string | The time the transaction takes place, expressed in the local time of the originator. The time is in hh:mm:ss format. | Yes | | merchantCategoryCode | string | Contains a code describing the merchant's type of business product or service, also known as the merchant category code (MCC) that was sent in the original request. | No | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | string | The VisaNet reference number for the transaction. This is the same transactionIdentifier previously received in the response for PushFunds transaction API calls.Note: When stan and rrn parameters combination is not used as query parameters, this parameter must be included as a query parameter. | Yes | | cardholderBillingAmount | string | Amount in card holder billing currency. | No | | dateAndTimeTransmission | string ( yyyy-MM-ddTHH:mm:ss.SSS) | This field contains the date and time the request is submitted to VisaNet. | Yes | | systemsTraceAuditNumber | string | A number assigned by the message initiator that uniquely identifies a transaction. This is the same as systemsTraceAuditNumber previously sent in the request for the original deferred OCT request. | Yes | | prepaidLoadBalanceAmount | string | Min Inclusive: -999999999.999.
    Max Inclusive: 999999999.999.
    Note: Applicable only for Top Up Transactions. | No | | retrievalReferenceNumber | string | It is a key data element for matching a message to others within a given transaction set. This is the same as retrievalReferenceNumber previously sent in the request for the original deferred OCT request. | Yes | | cardHolderBillingConvRate | string | This field contains the rate used by VisaNet to convert the transaction amount to cardholder billing amount. | No | | cardholderBillingCurrency | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the cardholderBillingAmount field. | No | | amountInTransactionCurrency | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the transactionAmount field. | Yes | | prepaidLoadBalanceCurrencyCode | string | The 3-digit ISO-4217 code in this field reflects the currency associated with prepaidLoadBalance | No | | countryCodePrimaryAccountNumber | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the card issuer institution. | Yes | | settlementConvRateDecimalPosition | string | This is a multicurrency field. It contains the rate used by Visa to convert the transaction amount to the settlement amount. | No | | cardHolderBillingConvRateDecimalPosition | string | This is an optional field and if conversionRateReconciliation is present, then rateDecimalPositions needs to be present. | No | #### DeleteAliasRequest-3 Schema Request payload data for deleting an alias.

    Note. This API allows issuer to delete only one mapping of an alias to an account at one time. To delete
    • the mappings of multiple aliases linked to the same PAN; and/or
    • the mappings of one alias linked to multiple accounts
    issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute is uniquely used by issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:

    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | #### CashOutCardAcceptor Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | Originator should populate this field with 'mVisa cash-out'. | Yes | | idCode | string | Originator can populate the field with any system generated reference number internal to originating client. | Yes | | address | { **"city"**: string, **"country"**: string } | | No | #### CashInPushPaymentPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | Transaction amount in merchant currency. Visa's rules do not permit cross border cash deposit transactions. | Yes | | senderName | string | Populate the field with merchant�s doing business as name (25 characters only). If the name is greater than 25 characters, use the first 25 characters. The name must be populated using the Roman i.e. English character set. | Yes | | acquiringBin | string | BIN number identifies the originator of cash-in transaction. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | | Yes | | senderReference | string | A reference number unique to the merchant. Field can be left blank. | No | | acquirerCountryCode | string | Use a 3-digit numeric country code for the country where the Visa Direct solution is registered. This must match the information provided during program enrollment. Refer to [ISO Codes](/request_response_codes#iso_country_codes). | Yes | | senderAccountNumber | string | This is optional field for cash-in transactions. | No | | merchantCategoryCode | string | Numeric only. Originators should populate 6012. If this field is not populated by the originator, it will automatically be set to the MCC value indicated during the API onboarding process. Recipient should populate the MCC of the merchant in the response message. | Yes | | businessApplicationId | string | Use CI (cash-in). This field is populated with business application identifier for the transaction. Refer to [businessApplicationId](/request_response_codes#businessApplicationId) codes | Yes | | systemsTraceAuditNumber | string | Numeric only. It is a key data element used to match a response to its request or to match a message to others for a given transaction. The value assigned to the original request should appear in all subsequent messages for that transaction | Yes | | transactionCurrencyCode | string | The code in this field must always reflect the currency associated to the amount in field Amount. Use a 3-digit numeric currency code for transaction currency. Refer to [ISO Codes](/request_response_codes#currency_codes). | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | The date and time the transaction takes place, expressed in the local date and time of the originator. | Yes | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. It is recommended that the client populate ydddhhnnnnnn value in this field. | Yes | | recipientPrimaryAccountNumber | string | Consumer PAN. 16-digit PAN as provided by the consumer to merchant. | Yes | #### MultiPushFundsTransactionGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to Action Code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Applicable only for Top Up Transactions | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | required when call times out | Yes | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | object | | No | | enablerVerificationValue | binary | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | #### CreateMerchantAliasRequest Schema Request payload data for creating a merchant or agent alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Merchant or agent city. | Yes | | aliasId | string | This attribute is used by acquirer to uniquely identify their merchant or agent. | Yes | | country | string | Merchant or agent country code as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | Yes | | aliasType | string | 01 – Phone number
    02 – Email address
    03 – USSD Payment ID
    04 – BID (Bank Identification Number)
    05 – National ID
    06 – Custom
    Null – Should start with visa assigned USSD Payment ID | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | Yes | | isAgentAlias | string | Optional and applicable for agent alias use only. If set as 'Y', agent alias to be created. | No | | recipientName | string | Merchant or agent name. | Yes | | convenienceFeeAmount | string | The convenience fee of a fixed amount. Applicable only for merchant alias. | No | | merchantCategoryCode | string | Merchant Category Code. Numeric only. | Yes | | payloadFormatIndicator | string | Defines the format of the merchant data payload. Payload Format Indicator must be set to '01' as per EMVCo Merchant Presented QR specifications. | Yes | | pointOfInitiationMethod | string | In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st character
    '1' = QR
    '2' = BLE
    '3' = NFC
    '4' - '9' = Reserved for Future Use
    2nd character
    '1' = Static
    '2' = Dynamic
    '3' - '9' = Reserved for Future Use.
    Example: '11' indicates QR static code, '12' indicates QR dynamic code. | No | | transactionCurrencyCode | string | As defined by ISO 4217. This is the transaction currency code that a merchant can accept for payment. 3-digit numeric presentation of the currency is recommended to be used if alias may be used for QR. | Yes | | convenienceFeePercentage | string | Applicable only for merchant alias. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). | No | | tipConvenienceFeeIndicator | string | Tip or Convenience Fee Indicator. This shall contains a value of '01', '02' or '03' as per EMVCo Merchant Presented QR specifications. Applicable only for merchant alias. | No | #### MerchantAliasResponse Schema Response if a merchant or agent is successfully created,updated or deleted. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasId | string | Identifier uniquely assigned by Acquirer to a merchant. This identifier of a merchant or agent of acquirer is returned if alias operation in Alias Directory is successful | No | #### PushFundsTransactionPostPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city.

    This field is also conditionally required for domestic Colombia transactions | No | | senderName | string | Conditional.

    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use senderFirstName, senderLastName & senderMiddleName instead.

    If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | secondaryId | string | secondaryId is used for C2B use case in the CEMEA region where payee initiates the OCT to the payer. The merchant or acquirer may use this field to obtain an Agreement Id in order to process the request. | No | | acquiringBin | number | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"taxID"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string, **"addressLine"**: string }, **"terminalId"**: string, **"urlAddress"**: string, **"partnerIDCode"**: string, **"legalBusinessName"**: string, **"contactInformation"**: { **"phoneNumber"**: string, **"additionalContactDetails"**: string, **"customerServicePhoneNumber"**: string }, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"country"**: string, **"postalCode"**: string, **"streetAddress"**: string }, **"subMerchantId"**: string, **"additionalAcceptor"**: { **"ids"**: [ { **"idType"**: string,
    **Available values:** "Marketplace", "Gateways", "StagedDigitalWallet", "RampProvider", **"idValue"**: string } ], **"foreignRetailerIndicator"**: string,
    **Available values:** "A", "B" }, **"independentSalesOrganizationID"**: string }, **"serviceLocationDetails"**: { **"address"**: { **"city"**: string, **"state"**: string, **"postalCode"**: string, **"countryCode"**: string } } } | | Yes | | sourceAmount | double | Conditional.

    Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | cardCvv2Value | string | The cardCvv2Value provided by the account holder for the recipientPrimaryAccountNumber in the request. cardCvv2Value is required for Mastercard transaction with BAI=GP(Gambling Payout) | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientName | string | Conditional.

    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use recipientFirstName, recipientLastName & recipientMiddleName instead.

    This field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | senderAddress | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | recipientState | string | Conditional.

    This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
    Note:
    It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
    It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements)

    Note:
    This field is not applicable for domestic Colombia transactions | No | | senderLastName | string | Conditional

    This field contains sender's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderFirstName | string | Conditional

    This field contains sender's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderReference | string | Conditional.

    Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
    Required, if the transaction is a funds disbursement, the field is required.
    Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

    Required if senderCountryCode is either 124(CAN) or 840(USA)

    Note:
    This field not applicable for domestic Colombia transactions | No | | purposeOfPayment | string | Conditional.

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | schemeIdentifier | string | Defines the card scheme selected of a co-badged cards for the transaction.Only 2 values supported.
    01-Visa
    02-Other
    The values will expand in future. | No | | senderEntityType | string | Optional.

    This field identifies if the sender is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderMiddleName | string | This field contains sender's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | senderOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | senderPostalCode | string | Conditional.

    When present, this field contains the sender's postal code
    Note: Required when cardAcceptor:address:country is US or CA

    Note: For domestic Colombia transactions, the maximum length of this field is 16 characters. For other transactions, the entered value should be between 5 and 10 characters. | No | | senderStreetName | string | Optional.

    This field contains the street name of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | Conditional.

    This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic transaction where businessApplicationId is "PS". | No | | messageReasonCode | number | Conditional.

    Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | Conditional

    This field contains recipient's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderCountryCode | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

    Alpha or numeric country code can be supported.

    This field is required when sending the transactions to some of the US debit networks.

    This field is required when sending the transactions to some of the US debit networks and for domestic Colombia transactions.

    Refer to ISO Codes | No | | senderDateOfBirth | date | This field contains the birth date for the sender.
    Format: YYYY-MM-DD
    Example: 2011-12-30 | No | | senderNationality | string | ISO country code of nationality in alphabets. | No | | sourceOfFundsCode | string | Conditional.

    If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

    If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

    If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

    If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

    Refer to sourceOfFundsCode codes | No | | pointOfServiceData | { **"panEntryMode"**: number, **"motoECIIndicator"**: number, **"posConditionCode"**: number, **"specialConditionIndicatorMerchant"**: string } | Conditional.

    Note: For a CardPresent Transactions, this field is required. | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | This is the invoice number or some other reference for billing purposes.
    e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up. | No | | recipientFirstName | string | Conditional

    This field contains recipient's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderAddressLine1 | string | Optional.

    This field contains the first line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderAddressLine2 | string | Optional.

    This field contains the second line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sourceCurrencyCode | string | Conditional.

    3-character alpha or numeric currency code for currency of the sourceAmount field.

    Refer to ISO Codes | No | | acquirerCountryCode | number | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientEntityType | string | Optional.

    This field identifies if the recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | recipientMiddleName | string | This field contains recipient's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | recipientOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientStreetName | string | This field contains the street name of the recipient address.

    Maps to the following ISO 8583 field
    - Field 56, Tag 88 | No | | senderAccountNumber | string | Conditional.

    If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), this field is required and must contain the sender's account number. If the transaction is a funds disbursement, the field is not required.

    Note: This is a 16-digit PAN or token which defines the account of the consumer (sender of push payment). | No | | senderLocalNameData | { **"lastName"**: string, **"aliasName"**: string, **"firstName"**: string, **"middleName"**: string, **"languageCode"**: string, **"dataEncodingFormat"**: string } | This object is used to provide the sender's local name data. This object is required for transactions where the sender's local name data is required. | No | | senderMiddleInitial | string | This field contains sender's middle initial.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | merchantCategoryCode | number | Conditional.

    If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    Note: required if not provided during onboarding | No | | recipientCountryCode | string | Conditional.

    This field contains the ISO 3166-1 country code of the recipient address.

    Refer to ISO Codes
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientDateOfBirth | date | Account Owner Date of Birth.(format YYYY-MM-DD) | No | | recipientNationality | string | ISO country code of nationality in alphabets. | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"ancillarySenderDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ] } | | No | | senderBuildingNumber | string | Optional.

    This field contains the house or the building number of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCountryOfBirth | string | ISO country code of birth in alphabets | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

    For Argentina domestic purchase transactions the value should be "PS".

    For Request To Pay, city will carry Invoice Id which will be used for C2B use case in the CEMEA region where payee initiates the OCT to the payer.

    Refer to businessApplicationId codes | Yes | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | number | Conditional.

    The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response. For Faster Refunds OCTs, clients are required to include the Visa Transaction ID from the original purchase transaction. | No | | recipientLocalNameData | { **"lastName"**: string, **"aliasName"**: string, **"firstName"**: string, **"middleName"**: string, **"languageCode"**: string, **"dataEncodingFormat"**: string } | This object is used to provide the recipient's local name data. This object is required for transactions where the recipient's local name data is required. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial.
    Note:
    Supported for Push Payments transactions associated with Gateway Service. (Refer to Mastercard data processing requirements) | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa.

    Note: For BAI as MI, either this field or cardAcceptor.paymentFacilitator.id or both should be present. | No | | merchantPseudoAbaNumber | string | Conditional.

    This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ], **"ancillaryRecipientDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | date | Conditional.

    This field contains the expiration date for the recipient's primary account number or token in recipientPrimaryAccountNumber.
    Note: Visa requires expiration date to be present in all OCTs destined to U.S. issuers
    Format: YYYY-MM
    Example: 2021-10 | No | | recipientCountryOfBirth | string | ISO country code of birth in alphabets | No | | systemsTraceAuditNumber | number | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | 3-character alpha or numeric currency code of the transaction as expressed in the amount field. This can be either:
    • The originator's chosen currency for the transaction OR
    • The recipient's card currency (refer to the billingCurrency obtained from the Funds Transfer Attribute Inquiry API)*
    Adjust amount accordingly based on chosen transactionCurrencyCode.
    *Note: This currency may not always be the local currency code of the recipient.

    Refer to ISO Codes | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3.
    Note: If a currency has three decimal places, the last digit of this field must be zero. | No | | retrievalReferenceNumber | number | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPersonalEmailAddress | string | Account owner email address. | No | | settlementServiceIndicator | number | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | recipientPersonalEmailAddress | string | Account owner email address. | No | | recipientPrimaryAccountNumber | string | This is a 16-digit PAN or token for the account of the recipient of push payment. | Yes | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | senderIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

    Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | senderIdentificationNumberIndividual | string | Conditional.

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification. | No | #### PushFundsTransactionPostPayload-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city.

    This field is also conditionally required for domestic Colombia transactions | No | | senderName | string | Conditional.

    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use senderFirstName, senderLastName & senderMiddleName instead.

    If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | secondaryId | string | secondaryId is used for C2B use case in the CEMEA region where payee initiates the OCT to the payer. The merchant or acquirer may use this field to obtain an Agreement Id in order to process the request. | No | | acquiringBin | number | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"taxID"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string, **"addressLine"**: string }, **"terminalId"**: string, **"urlAddress"**: string, **"partnerIDCode"**: string, **"legalBusinessName"**: string, **"contactInformation"**: { **"phoneNumber"**: string, **"additionalContactDetails"**: string, **"customerServicePhoneNumber"**: string }, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"subMerchantId"**: string, **"independentSalesOrganizationID"**: string }, **"serviceLocationDetails"**: { **"address"**: { **"city"**: string, **"state"**: string, **"postalCode"**: string, **"countryCode"**: string } } } | | Yes | | sourceAmount | double | Conditional.

    Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientName | string | Conditional.

    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use recipientFirstName, recipientLastName & recipientMiddleName instead.

    This field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | senderAddress | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | recipientState | string | Conditional.

    This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
    Note:
    It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
    It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements)

    Note:
    This field is not applicable for domestic Colombia transactions | No | | senderLastName | string | Conditional

    This field contains sender's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderFirstName | string | Conditional

    This field contains sender's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderReference | string | Conditional.

    Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
    Required, if the transaction is a funds disbursement, the field is required.
    Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

    Required if senderCountryCode is either 124(CAN) or 840(USA)

    Note:
    This field not applicable for domestic Colombia transactions | No | | purposeOfPayment | string | Conditional.

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | senderEntityType | string | Optional.

    This field identifies if the sender is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderMiddleName | string | This field contains sender's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | senderPostalCode | string | Conditional.

    When present, this field contains the sender's postal code
    Note: Required when cardAcceptor:address:country is US or CA

    Note: For domestic Colombia transactions, the maximum length of this field is 16 characters. For other transactions, the entered value should be between 5 and 10 characters. | No | | senderStreetName | string | Optional.

    This field contains the street name of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | Conditional.

    This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic transaction where businessApplicationId is "PS". | No | | messageReasonCode | number | Conditional.

    Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | Conditional

    This field contains recipient's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderCountryCode | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

    Alpha or numeric country code can be supported.

    This field is required when sending the transactions to some of the US debit networks.

    This field is required when sending the transactions to some of the US debit networks and for domestic Colombia transactions.

    Refer to ISO Codes | No | | senderDateOfBirth | date | This field contains the birth date for the sender.
    Format: YYYY-MM-DD
    Example: 2011-12-30 | No | | sourceOfFundsCode | string | Conditional.

    If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

    If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

    If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

    If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

    Refer to sourceOfFundsCode codes | No | | pointOfServiceData | { **"panEntryMode"**: number, **"motoECIIndicator"**: number, **"posConditionCode"**: number, **"specialConditionIndicatorMerchant"**: string } | Conditional.

    Note: For a CardPresent Transactions, this field is required. | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | This is the invoice number or some other reference for billing purposes.
    e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up. | No | | recipientFirstName | string | Conditional

    This field contains recipient's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderAddressLine1 | string | Optional.

    This field contains the first line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderAddressLine2 | string | Optional.

    This field contains the second line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sourceCurrencyCode | string | Conditional.

    3-character alpha or numeric currency code for currency of the sourceAmount field.

    Refer to ISO Codes | No | | acquirerCountryCode | number | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientEntityType | string | Optional.

    This field identifies if the recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | recipientMiddleName | string | This field contains recipient's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientStreetName | string | This field contains the street name of the recipient address.

    Maps to the following ISO 8583 field
    - Field 56, Tag 88 | No | | senderAccountNumber | string | Conditional.

    If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), this field is required and must contain the sender's account number. If the transaction is a funds disbursement, the field is not required.

    Note: This is a 16-digit PAN or token which defines the account of the consumer (sender of push payment). | No | | senderMiddleInitial | string | This field contains sender's middle initial.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | merchantCategoryCode | number | Conditional.

    If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    Note: required if not provided during onboarding | No | | recipientCountryCode | string | Conditional.

    This field contains the ISO 3166-1 country code of the recipient address.

    Refer to ISO Codes
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"ancillarySenderDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ] } | | No | | senderBuildingNumber | string | Optional.

    This field contains the house or the building number of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

    For Argentina domestic purchase transactions the value should be "PS".

    For Request To Pay, city will carry Invoice Id which will be used for C2B use case in the CEMEA region where payee initiates the OCT to the payer.

    Refer to businessApplicationId codes | Yes | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | number | Conditional.

    The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response. For Faster Refunds OCTs, clients are required to include the Visa Transaction ID from the original purchase transaction. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial.
    Note:
    Supported for Push Payments transactions associated with Gateway Service. (Refer to Mastercard data processing requirements) | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa.

    Note: For BAI as MI, either this field or cardAcceptor.paymentFacilitator.id or both should be present. | No | | merchantPseudoAbaNumber | string | Conditional.

    This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ], **"ancillaryRecipientDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | date | Conditional.

    This field contains the expiration date for the recipient's primary account number or token in recipientPrimaryAccountNumber.
    Note: Visa requires expiration date to be present in all OCTs destined to U.S. issuers
    Format: YYYY-MM
    Example: 2021-10 | No | | systemsTraceAuditNumber | number | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. You should (unless prohibited by local law / regulation) use the billingCurrencyCode obtained from the Funds Transfer Attribute Inquiry API under Payment Account Attribute Inquiry.

    Refer to ISO Codes | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3.
    Note: If a currency has three decimal places, the last digit of this field must be zero. | No | | retrievalReferenceNumber | number | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | settlementServiceIndicator | number | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: number, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: number, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | recipientPrimaryAccountNumber | string | This is a 16-digit PAN or token for the account of the recipient of push payment. | Yes | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | senderIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

    Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | senderIdentificationNumberIndividual | string | Conditional.

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification. | No | #### PushFundsTransactionPostPayload-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero. | Yes | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city. | No | | senderName | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's name.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the name of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's name.
    Required, if the transaction will be routed to Maestro & STAR networks via Visa Push Payments Gateway Service (PPGS). If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. PPGS uses senderName if all the following fields are available: senderName, senderFirstName, senderLastName and senderMiddleName

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | acquiringBin | number | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string, **"legalBusinessName"**: string, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"subMerchantId"**: string } } | | Yes | | sourceAmount | double | Conditional.

    Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientName | string | Conditional.

    Recipient name is required for cross-border enhanced money transfer OCTs. | No | | senderAddress | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address. | No | | recipientState | string | Conditional.

    This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
    Note:
    It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
    It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements) | No | | senderLastName | string | Conditional.

    This field contains sender's last name
    Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs or the PPGS implementation guide.

    If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | deferredOCTData | { **"requestType"**: string } | Requesting Visa to process the request as a deferred OCT transaction. | No | | senderFirstName | string | Conditional.

    This field contains sender's first name
    Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs and the PPGS implementation guide.

    If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | senderReference | string | Conditional.

    Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
    Required, if the transaction is a funds disbursement, the field is required.
    Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

    Required if senderCountryCode is either 124(CAN) or 840(USA) | No | | purposeOfPayment | string | Conditional.

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | senderMiddleName | string | This field contains sender's middle name
    If this field is sent it will be passed to networks, as an optional field, through which transaction is routed when using Visa Push Payments Gateway Service (PPGS). | No | | senderPostalCode | string | Conditional.

    When present, this field contains the sender's postal code
    Note: Required when cardAcceptor:address:country is US or CA | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | number | Conditional.

    Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | Conditional.

    When present, this field contains recipient's last name.
    Note: Supported for Push Payments transactions associated with Gateway Service. (Refer to Mastercard data processing requirements) | No | | senderCountryCode | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

    Alpha or numeric country code can be supported.

    This field is required when sending the transactions to some of the US debit networks.

    Refer to ISO Codes | No | | senderDateOfBirth | date | This field contains the birth date for the sender.
    Format: YYYY-MM-DD
    Example: 12-30-2011 | No | | sourceOfFundsCode | string | Conditional.

    If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

    If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

    If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

    If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

    Refer to sourceOfFundsCode codes | No | | pointOfServiceData | { **"panEntryMode"**: number, **"motoECIIndicator"**: number, **"posConditionCode"**: number, **"specialConditionIndicatorMerchant"**: string } | Conditional.

    Note: For a CardPresent Transactions, this field is required. | No | | recipientFirstName | string | Conditional.

    When present, this field contains recipient's first name.
    Note: Supported for Push Payments transactions associated with Gateway Service. (Refer to Mastercard data processing requirements) | No | | sourceCurrencyCode | string | Conditional.

    3-character alpha or numeric currency code for currency of the sourceAmount field.

    Refer to ISO Codes | No | | acquirerCountryCode | number | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientMiddleName | string | This field contains recipient's middle name | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientStreetName | string | Optional.

    This field contains the street name of the recipient address. | No | | senderAccountNumber | string | Conditional.

    If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), this field is required and must contain the sender's account number. If the transaction is a funds disbursement, the field is not required.

    Note: This is a 16-digit PAN or token which defines the account of the consumer (sender of push payment). | No | | senderMiddleInitial | string | This field contains sender's middle initial. | No | | merchantCategoryCode | number | Conditional.

    If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    Note: required if not provided during onboarding | No | | recipientCountryCode | string | Conditional.

    This field contains the ISO 3166-1 country code of the recipient address.

    Refer to ISO Codes
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ] } | | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

    Refer to businessApplicationId codes | Yes | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | transactionIdentifier | number | Conditional.

    The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response.

    Note: provide only if there is a corresponding AFT transaction response. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial.
    Note:
    Supported for Push Payments transactions associated with Gateway Service. (Refer to Mastercard data processing requirements) | No | | merchantPseudoAbaNumber | string | Conditional.

    This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | date | Conditional.

    This field contains the expiration date for the recipient's primary account number or token in recipientPrimaryAccountNumber.
    Note: Visa requires expiration date to be present in all OCTs destined to U.S. issuers
    Format: YYYY-MM
    Example: 2021-10 | No | | systemsTraceAuditNumber | number | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. You should (unless prohibited by local law / regulation) use the billingCurrencyCode obtained from the Funds Transfer Attribute Inquiry API under Payment Account Attribute Inquiry.

    Refer to ISO Codes | Yes | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3.
    Note: If a currency has three decimal places, the last digit of this field must be zero. | No | | retrievalReferenceNumber | number | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, this field contains the Argentina member supplied reimbursement fee. If present, populate 0 | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | settlementServiceIndicator | number | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: number, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: number, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | recipientPrimaryAccountNumber | string | This is a 16-digit PAN or token for the account of the recipient of push payment. | Yes | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address. | No | | senderIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

    Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | senderIdentificationNumberIndividual | string | Conditional.

    This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains the customer’s VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments),

    Note: If senderIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions.
    If businessApplicationId has PS, then this field to be populated for Argentina domestic transaction. | No | #### PushFundsTransactionPostPayload-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero. | Yes | | pinData | { **"pinDataBlock"**: binary, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city.

    This field is also conditionally required for domestic Colombia transactions. | No | | senderName | string | **Conditional** The sender name can be up to 30 characters long and must be the sender's legal name. If the sender's name is greater than thirty (30) characters, use only the first 30 characters of the name. **Important:** Please do not use this field for non-Visa transactions and for domestic Colombia transactions. Use `senderFirstName`, `senderLastName` & `senderMiddleName` instead. **Usage Guidelines:** - If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds - If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name **Recommended Format:** Last Name/Family Surname 1 + space + Last Name/Family Surname 2 (optional) + space + First Name + space + Middle Initial or Middle Name (optional) **Note:** - This field must not contain a ? (question mark) or any special characters - Only a valid and legal sender name must be populated in this field **Example:** Doe John A | No | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | secondaryId | string | secondaryId is used for C2B use case in the CEMEA region where payee initiates the OCT to the payer. The merchant or acquirer may use this field to obtain an Agreement Id in order to process the request. | No | | acquiringBin | number | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"taxID"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string, **"addressLine"**: string }, **"terminalId"**: string, **"urlAddress"**: string, **"partnerIDCode"**: string, **"legalBusinessName"**: string, **"contactInformation"**: { **"phoneNumber"**: string, **"additionalContactDetails"**: string, **"customerServicePhoneNumber"**: string }, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"country"**: string, **"postalCode"**: string, **"streetAddress"**: string }, **"subMerchantId"**: string, **"additionalAcceptor"**: { **"ids"**: [ { **"idType"**: string,
    **Available values:** "Marketplace", "Gateways", "StagedDigitalWallet", "RampProvider", **"idValue"**: string } ], **"foreignRetailerIndicator"**: string }, **"independentSalesOrganizationID"**: string }, **"serviceLocationDetails"**: { **"address"**: { **"city"**: string, **"state"**: string, **"postalCode"**: string, **"countryCode"**: string } } } | | Yes | | sourceAmount | double | **Conditional** Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | cardCvv2Value | string | The cardCvv2Value value provided by the account holder for the recipientPrimaryAccountNumber in the request. cardCvv2Value is required for Mastercard transaction with BAI=GP(Gambling Payout) | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions.
    This field is required for cross-border transactions over CAD1000.00 from Canada | No | | recipientName | string | **Conditional** The recipient name can be up to 30 characters long and must be the recipient's legal name. If the recipient's name is greater than thirty (30) characters, use only the first 30 characters of the name. Please do not use this field for non-Visa transactions and for domestic Colombia transactions. Use `recipientFirstName`, `recipientLastName` & `recipientMiddleName` instead. This field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards. **Recommended Format:** \|Last Name/Family Surname 1 plus space \| Last Name/Family Surname 2(optional) plus space \| First Name plus space \| Middle Initial or Middle Name(optional) **Note:**- - This field must not contain a ? (question mark) or any special characters - Only a valid and legal recipient name must be populated in this field. **Example:** Doe John A | No | | senderAddress | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | recipientState | string | Conditional.

    This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
    Note:
    It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
    It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements)

    Note:
    This field is not applicable for domestic Colombia transactions | No | | senderLastName | string | Conditional

    This field contains sender's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderFirstName | string | Conditional

    This field contains sender's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderReference | string | Conditional.

    Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
    Required, if the transaction is a funds disbursement, the field is required.
    Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

    Required if senderCountryCode is either 124(CAN) or 840(USA)

    Note:
    This field is not applicable for domestic Colombia transactions | No | | purposeOfPayment | string | **Conditional** This is an alphanumeric value. Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. - For India, Bangladesh, Egypt and Argentina: Purpose of payment is mandatory for all BAIs except CO, CI and MP - For Chile: Purpose of payment is mandatory for BAI-FD - For Colombia: Purpose of payment is mandatory for BAI-AA and PP - For Saudi Arabia: Purpose of payment is mandatory for all BAIs | No | | schemeIdentifier | string | Defines the card scheme selected of a co-badged cards for the transaction.Only 2 values supported.
    01-Visa
    02-Other
    The values will expand in future. | No | | senderEntityType | string | Optional.

    This field identifies if the sender is a business or an individual. The valid value are 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderMiddleName | string | This field contains sender's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | senderOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | senderPostalCode | string | Conditional.

    When present, this field contains the sender's postal code
    Note: Required when cardAcceptor:address:country is US or CA and for domestic Colombia transactions.

    Note: For domestic Colombia transactions, the maximum length of this field is 16 characters. For other transactions, the entered value should be between 5 and 10 characters. | No | | senderStreetName | string | Optional.

    This field contains the street name of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | Conditional.

    This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic transaction where businessApplicationId is "PS". | No | | messageReasonCode | number | Conditional.

    Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | Conditional

    This field contains recipient's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderCountryCode | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

    Alpha or numeric country code can be supported.

    This field is required when sending the transactions to some of the US debit networks and for domestic Colombia transactions.

    Refer to ISO Codes | No | | senderDateOfBirth | date | This field contains the birth date for the sender.
    Format: YYYY-MM-DD
    Example: 2011-12-30 | No | | senderNationality | string | ISO country code of nationality in alphabets. | No | | sourceOfFundsCode | string | Conditional.

    If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

    If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

    If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

    If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

    Refer to sourceOfFundsCode codes | No | | cardSequenceNumber | integer | Card Sequence Number
    *Example:* `1` | No | | magneticStripeData | { **"track1Data"**: string } or { **"track2Data"**: binary } | | No | | pointOfServiceData | { **"panEntryMode"**: number, **"motoECIIndicator"**: number, **"posConditionCode"**: number, **"specialConditionIndicatorMerchant"**: string } | Conditional Required for Card Present Transfer Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done. Note: For a CardPresent or Token Transactions, this field is required. If this Object is not passed in the request then API will default at following values: "pointOfServiceData": { "panEntryMode": "01","posConditionCode": "59","motoECIIndicator":"7"}" | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | This is the invoice number or some other reference for billing purposes.
    e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up. | No | | recipientFirstName | string | Conditional

    This field contains recipient's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderAddressLine1 | string | Optional.

    This field contains the first line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderAddressLine2 | string | Optional.

    This field contains the second line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sourceCurrencyCode | string | **Conditional** 3-character alpha or numeric currency code for currency of the sourceAmount field. Refer to [ISO Codes](/request_response_codes#iso_country_and_currency_codes) | No | | acquirerCountryCode | number | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientEntityType | string | Optional.

    This field identifies if the recipient is a business or an individual. The valid value are 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | recipientMiddleName | string | This field contains recipient's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | recipientOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientStreetName | string | This field contains the street name of the recipient address.

    Maps to the following ISO 8583 field
    - Field 56, Tag 88 | No | | senderAccountNumber | string | **Conditional** If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), this field is required and must contain the sender's account number. If the transaction is a funds disbursement, the field is not required. **Note:** This is a 16-digit PAN or token which defines the account of the consumer (sender of push payment). **Note:** PAN or a network token must not be used if Payment Credential Reference is used to send sender's PCI Token Reference ID. Only one of 'senderAccountNumber' and 'senderPaymentCredentialReference' is provided in a request | No | | senderLocalNameData | { **"lastName"**: string, **"aliasName"**: string, **"firstName"**: string, **"middleName"**: string, **"languageCode"**: string, **"dataEncodingFormat"**: string } | This object is used to provide the sender's local name data. This object is required for transactions where the sender's local name data is required. | No | | senderMiddleInitial | string | This field contains sender's middle initial.

    Note:
    This field is not applicable for domestic Colombia transactions. | No | | merchantCategoryCode | number | Conditional.

    If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    Note: required if not provided during onboarding | No | | recipientCountryCode | string | Conditional.

    This field contains the ISO 3166-1 country code of the recipient address.

    Refer to ISO Codes
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientDateOfBirth | date | Account Owner Date of Birth.(format YYYY-MM-DD) | No | | recipientNationality | string | ISO country code of nationality in alphabets. | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string,
    **Available values:** "CUID", "NTID", "PASN", "DRLN", "TXIN", "CPNY", "PRXY", "SSNB", "ARNB", "LAWE", "MILI", "TRVL", "EMAL", "PHON", "BTHD", **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"ancillarySenderDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ] } | | No | | senderBuildingNumber | string | Optional.

    This field contains the house or the building number of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCountryOfBirth | string | ISO country code of birth in alphabets | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

    For Argentina domestic purchase transactions the value should be "PS".

    For Request To Pay, city will carry Invoice Id which will be used for C2B use case in the CEMEA region where payee initiates the OCT to the payer.

    Refer to businessApplicationId codes
    *Example:* `"AA"` | Yes | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions.
    This field is required for cross-border transactions over CAD1000.00 from Canada | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | number (int64) | Conditional.

    The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response. For Faster Refunds OCTs, clients are required to include the Visa Transaction ID from the original purchase transaction. | No | | recipientLocalNameData | { **"lastName"**: string, **"aliasName"**: string, **"firstName"**: string, **"middleName"**: string, **"languageCode"**: string, **"dataEncodingFormat"**: string } | This object is used to provide the recipient's local name data. This object is required for transactions where the recipient's local name data is required. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial.
    Note:
    Supported for Push Payments transactions associated with Gateway Service. (Refer to Mastercard data processing requirements) | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa.

    Note: For BAI as MI, either this field or cardAcceptor.paymentFacilitator.id or both should be present. | No | | merchantPseudoAbaNumber | string | Conditional.

    This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string,
    **Available values:** "CUID", "NTID", "PASN", "DRLN", "TXIN", "CPNY", "PRXY", "SSNB", "ARNB", "LAWE", "MILI", "TRVL", "EMAL", "PHON", "BTHD", **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ], **"ancillaryRecipientDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | date | Conditional.

    This field contains the expiration date for the recipient's primary account number or token in recipientPrimaryAccountNumber.
    Note: Visa requires expiration date to be present in all OCTs destined to U.S. issuers
    Format: YYYY-MM
    Example: 2021-10 | No | | recipientCountryOfBirth | string | ISO country code of birth in alphabets | No | | systemsTraceAuditNumber | number | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | 3-character alpha or numeric currency code of the transaction as expressed in the amount field. This can be either:
    • The originator's chosen currency for the transaction OR
    • The recipient's card currency (refer to the billingCurrency obtained from the Funds Transfer Attribute Inquiry API)*
    Adjust amount accordingly based on chosen transactionCurrencyCode.
    *Note: This currency may not always be the local currency code of the recipient.

    Refer to ISO Codes | Yes | | additionalPOSInformation | { **"chipConditionCode"**: integer, **"chipTransactionIndicator"**: integer, **"chipAuthenticationReliabilityIndicator"**: integer } | | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3.
    Note: If a currency has three decimal places, the last digit of this field must be zero. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer, **"acceptsPartialAuthorizations"**: integer } | Conditional Note: For a CardPresent Transactions, this field is required. If this object is not present API will default following values "pointOfServiceCapability": {"posTerminalType": "0","posTerminalEntryCapability": "1","acceptsPartialAuthorizations":"false"}" | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | integratedCircuitCardData | string | A blob containing the Chip card data in TLV format.
    *Example:* `"8201495F2A0201245F34010182021C008407A0000000031010950580000000009A031102249B0268009C01009F02060000000000009F03060000000000009F0607A00000000310109F0802008C9F0902008C9F100706010A039000009F1A0201249F2608423158936ED6C38F9F2701809F3303E0B0C89F34034103029F3501229F360200019F3704ACAC66E89F5800DF0100DF0200DF0400"` | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPersonalEmailAddress | string | Account owner email address. | No | | settlementServiceIndicator | number | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | recipientPersonalEmailAddress | string | Account owner email address. | No | | recipientPrimaryAccountNumber | string | This is a 16-digit PAN or token for the account of the recipient of push payment. Conditional Only one of 'recipientPrimaryAccountNumber' and 'recipientPaymentCredentialReference' is provided in a request | No | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient

    Note:
    This field is not applicable for domestic Colombia transactions address. | No | | senderPaymentCredentialReference | { **"type"**: string,
    **Available values:** "PCI_TOKEN_REFID", **"value"**: string, **"merchantId"**: string } | Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID Conditional Only one of 'senderAccountNumber' and 'senderPaymentCredentialReference' is provided in a request | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | senderIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

    Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | recipientPaymentCredentialReference | { **"type"**: string,
    **Available values:** "PCI_TOKEN_REFID", "PAYNAME", "PHONE", "EMAIL", "DIRECTORY_ALIASID", **"value"**: string, **"merchantId"**: string } | Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID or Visa+ Payname. Conditional Only one of 'recipientPrimaryAccountNumber' and 'recipientPaymentCredentialReference' is provided in a request. | No | | senderIdentificationNumberIndividual | string | Conditional.

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification. | No | #### GenerateReportRequest Schema Request payload data to generate a report. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | Specify the type of alias records to be contained in the report.
    Valid values are CONSUMER, MERCHANT and AGENT. | Yes | | limit | string | Maximum number of records to be contained in each page of the report.
    Default is set to a maximum of 20,000 records per page of a report.
    Minimum value is 1, Maximum value is 20,000. | No | | status | string | If not provided, default report contains alias records with all valid status, i.e.
    Consumer alias report will contain 'ACTIVE','INACTIVE' and 'DISABLED' records
    Merchant alias report will contain 'ACTIVE' and 'DISABLED' records
    Agent alias report will contain 'ACTIVE' and 'DISABLED' records.
    Valid values for status are 'ACTIVE', 'INACTIVE' and 'DISABLED'. | No | | reportStartDate | string | The start date of a report. Follows ISO 8601, date format YYYY-MM-DD. Example: 2019-01-01.
    If not set, it will be default to the previous date (T-1). | No | #### DeleteAliasRequest-1 Schema Request payload data for deleting an alias.

    Note. This API allows issuer to delete only one mapping of an alias to an account at one time. To delete
    • the mappings of multiple aliases linked to the same PAN; and/or
    • the mappings of one alias linked to multiple accounts
    issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute is uniquely used by issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:

    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | #### DeleteAliasRequest-2 Schema Request payload data for deleting an alias.

    Note. This API allows issuer to delete only one mapping of an alias to an account at one time. To delete
    • the mappings of multiple aliases linked to the same PAN; and/or
    • the mappings of one alias linked to multiple accounts
    issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute is uniquely used by issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:

    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | #### MultiPullFundsTransactionGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response_code
    Note: : The VisaNet Response Source for the transaction | Yes | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

    Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z
    Note: Remove "000Z" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request. | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | Conditional
    If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
    Please reach out to your Visa representative for details. | No | | enablerVerificationValue | binary | This field is to allow the application of the interchange discount at the enabler level. | No | | recipientIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments) | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).

    Note:Supported only in US for CPS (Custom Payment Service).

    Please reach out to your Visa representative for details. | No | #### MultiPullFundsTransactionPostPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"cavv"**: string, **"amount"**: double, **"pinData"**: { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } }, **"surcharge"**: string (double), **"senderCity"**: string, **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"cardCvv2Value"**: string, **"senderAddress"**: string, **"memberComments"**: string, **"recipientState"**: string, **"senderLastName"**: string, **"senderFirstName"**: string, **"senderReference"**: string, **"senderStateCode"**: string, **"senderPostalCode"**: string, **"sharingGroupCode"**: string, **"merchantReference"**: string, **"messageReasonCode"**: integer, **"recipientLastName"**: string, **"senderCountryCode"**: string, **"sourceOfFundsCode"**: string, **"magneticStripeData"**: { **"track1Data"**: string, **"track2Data"**: string }, **"pointOfServiceData"**: { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer }, **"recipientFirstName"**: string, **"riskAssessmentData"**: { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string }, **"senderCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"senderAccountNumber"**: string, **"senderMiddleInitial"**: string, **"recipientCountryCode"**: string, **"senderCardExpiryDate"**: string, **"originalTransactionId"**: integer, **"recipientMiddleInitial"**: string, **"visaMerchantIdentifier"**: string, **"addressVerificationData"**: { **"street"**: string, **"postalCode"**: string }, **"merchantPseudoAbaNumber"**: string, **"systemsTraceAuditNumber"**: integer, **"enablerVerificationValue"**: string, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"pointOfServiceCapability"**: { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer }, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"senderPrimaryAccountNumber"**: string, **"settlementServiceIndicator"**: integer, **"foreignExchangeFeeTransaction"**: double, **"recipientIdentificationNumberBusiness"**: string, **"recipientIdentificationNumberIndividual"**: string, **"cpsAuthorizationCharacteristicsIndicator"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | merchantCategoryCode | integer | Note: If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned). | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    Refer to businessApplicationId codes | No | | localTransactionDateTime | dateTime | | Yes | #### MultiPullFundsTransactionPostPayload-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"cavv"**: string, **"amount"**: double, **"pinData"**: { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } }, **"surcharge"**: string (double), **"senderCity"**: string, **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"cardCvv2Value"**: string, **"senderAddress"**: string, **"memberComments"**: string, **"recipientState"**: string, **"senderLastName"**: string, **"senderFirstName"**: string, **"senderReference"**: string, **"senderStateCode"**: string, **"senderPostalCode"**: string, **"sharingGroupCode"**: string, **"merchantReference"**: string, **"messageReasonCode"**: integer, **"recipientLastName"**: string, **"senderCountryCode"**: string, **"sourceOfFundsCode"**: string, **"magneticStripeData"**: { **"track1Data"**: string, **"track2Data"**: string }, **"pointOfServiceData"**: { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer }, **"recipientFirstName"**: string, **"riskAssessmentData"**: { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string }, **"senderCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"senderAccountNumber"**: string, **"senderMiddleInitial"**: string, **"recipientCountryCode"**: string, **"senderCardExpiryDate"**: string, **"originalTransactionId"**: integer, **"recipientMiddleInitial"**: string, **"visaMerchantIdentifier"**: string, **"addressVerificationData"**: { **"street"**: string, **"postalCode"**: string }, **"merchantPseudoAbaNumber"**: string, **"systemsTraceAuditNumber"**: integer, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"pointOfServiceCapability"**: { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer }, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"senderPrimaryAccountNumber"**: string, **"settlementServiceIndicator"**: integer, **"foreignExchangeFeeTransaction"**: double, **"recipientIdentificationNumberBusiness"**: string, **"recipientIdentificationNumberIndividual"**: string, **"cpsAuthorizationCharacteristicsIndicator"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | merchantCategoryCode | integer | Note: If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned). | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    Refer to businessApplicationId codes | No | | localTransactionDateTime | dateTime | | Yes | #### MultiPushFundsTransactionRequests-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city. | Yes | | senderName | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's name.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the name of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's name.
    Required, if the transaction will be routed to Maestro & STAR networks via Visa Push Payments Gateway Service (PPGS). If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. PPGS uses senderName if all the following fields are available: senderName, senderFirstName, senderLastName and senderMiddleName

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | Yes | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | sourceAmount | double | Conditional

    Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | cardCvv2Value | string | The cardCvv2Value provided by the account holder for the recipientPrimaryAccountNumber in the request. cardCvv2Value is required for Mastercard transaction with BAI=GP(Gambling Payout) | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientName | string | Recipient name is required for cross-border enhanced money transfer OCTs. | No | | senderAddress | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address. | Yes | | recipientState | string | Conditional.

    This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
    Note:
    It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
    It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements) | No | | senderLastName | string | Conditional.

    This field contains sender's last name
    Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs or the PPGS implementation guide.

    If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | senderFirstName | string | Conditional.

    This field contains sender's first name
    Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs and the PPGS implementation guide.

    If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | senderReference | string | Conditional.

    Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
    Required, if the transaction is a funds disbursement, the field is required.
    Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Required if SenderCountryCode is either 124(CAN) or 840(USA) | No | | purposeOfPayment | string | Conditional

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | senderMiddleName | string | This field contains sender's middle name
    If this field is sent it will be passed to networks, as an optional field, through which transaction is routed when using Visa Push Payments Gateway Service (PPGS). | No | | senderPostalCode | string | When present, this field contains the sender's postal code | Yes | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | integer | Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases.
    For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | When present, this field contains recipient's last name | No | | senderCountryCode | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

    Alpha or numeric country code can be supported.

    This field is required when sending the transactions to some of the US debit networks.

    Refer to ISO Codes | No | | senderDateOfBirth | string | The birth date for the sender | No | | sourceOfFundsCode | string | If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

    If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

    If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

    If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

    Refer to sourceOfFundsCode codes | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | This is the invoice number or some other reference for billing purposes.
    e.g. For Airtime top up, this should contain the mobile number (MSISDN) that is being topped up. | No | | recipientFirstName | string | When present, this field contains recipient's first name | No | | sourceCurrencyCode | string | Conditional

    3-character alpha or numeric currency code for currency of the sourceAmount field.

    Refer to ISO Codes | No | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientMiddleName | string | This field contains recipient's middle name | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientStreetName | string | Optional.

    This field contains the street name of the recipient address. | No | | senderAccountNumber | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), and if the SenderCardId attribute is not sent, this field is required and must contain the sender's account number.

    If the transaction is a funds disbursement, the field is not required. | No | | senderMiddleInitial | string | This field contains sender's middle initial | No | | recipientCountryCode | string | Conditional.

    This field contains the ISO 3166-1 country code of the recipient address.

    Refer to ISO Codes
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | string | The expiration date for the recipient's primary account number in recipientPrimaryAccountNumber | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. You should (unless prohibited by local law / regulation) use the billingCurrencyCode obtained from the Funds Transfer Attribute Inquiry API under Payment Account Attribute Inquiry.

    Refer to ISO Codes | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
    Note:
    If a currency has one decimal place, the last digit of this field must be zero.
    If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | recipientPrimaryAccountNumber | string | The recipient's PAN. | Yes | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address. | No | | senderIdentificationNumberBusiness | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements) | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains customer's VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | #### MultiPushFundsTransactionRequests-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The transaction amount to be delivered to the recipient. | Yes | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's city.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the city of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's city. | Yes | | senderName | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's name.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the name of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's name.
    Required, if the transaction will be routed to Maestro & STAR networks via Visa Push Payments Gateway Service (PPGS). If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. PPGS uses senderName if all the following fields are available: senderName, senderFirstName, senderLastName and senderMiddleName

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | Yes | | accountType | string | This is used to identify the account type of the recipientPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | sourceAmount | double | Conditional

    Source Amount is required in certain markets to identify the transaction amount entered in the sender's currency code prior to FX conversion by the originating entity. | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientName | string | Recipient name is required for cross-border enhanced money transfer OCTs. | No | | senderAddress | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's address.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the address of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's address. | Yes | | recipientState | string | Conditional.

    This field contains the state or province (ISO 3166-2 subdivision) code of the recipient address.
    Note:
    It is required for cross-border transactions either originating from or destined to Canada with recipientCountryCode of 840(USA) or 124(CAN).
    It is also required for Push Payments transactions associated with Gateway Service when recipientCountryCode is either 124(CAN) or 840(USA). (Refer to Mastercard data processing requirements) | No | | senderLastName | string | Conditional.

    This field contains sender's last name
    Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs or the PPGS implementation guide.

    If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | senderFirstName | string | Conditional.

    This field contains sender's first name
    Required when the transaction is routed over Maestro or STAR network via the Visa Push Payments Gateway Service (PPGS). For details on when the transaction maybe routed over Maestro or STAR please check the your PPGS implementation configs and the PPGS implementation guide.

    If this field is sent and transaction is not routed over Maestro & STAR the field is still sent to the other networks as an optional field. | No | | senderReference | string | Conditional.

    Required, if the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.
    Required, if the transaction is a funds disbursement, the field is required.
    Required, if the transaction will be routed to STAR networks via Visa Push Payments Gateway Service. If this field is sent and transaction is not routed over STAR the field is still sent to the other networks as an optional field.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Required if SenderCountryCode is either 124(CAN) or 840(USA) | No | | purposeOfPayment | string | Conditional

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | senderMiddleName | string | This field contains sender's middle name
    If this field is sent it will be passed to networks, as an optional field, through which transaction is routed when using Visa Push Payments Gateway Service (PPGS). | No | | senderPostalCode | string | When present, this field contains the sender's postal code | Yes | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | integer | Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases.
    For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | recipientLastName | string | When present, this field contains recipient's last name | No | | senderCountryCode | string | If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's country code.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the country code of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's country code.

    Alpha or numeric country code can be supported.

    This field is required when sending the transactions to some of the US debit networks.

    Refer to ISO Codes | No | | senderDateOfBirth | string | The birth date for the sender | No | | sourceOfFundsCode | string | If the transaction is a money transfer, the field is required and must contain a valid sourceOfFundsCode code that matches the funding instrument.

    If the transaction is a funds disbursement, the field is required and most likely contains a "05" as the sourceOfFundsCode code to identify that the merchant or government entity used a deposit account to fund the disbursement

    If the transaction is a pre-paid load, the field is required if the transaction is non-U.S. domestic.

    If the transaction is a credit bill pay, the field is required if the transaction is non-U.S. domestic, and the sourceOfFundsCode code must not contain a "01" or "06".

    Refer to sourceOfFundsCode codes | No | | recipientFirstName | string | When present, this field contains recipient's first name | No | | sourceCurrencyCode | string | Conditional

    3-character alpha or numeric currency code for currency of the sourceAmount field.

    Refer to ISO Codes | No | | feeProgramIndicator | string | Note: If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientMiddleName | string | This field contains recipient's middle name | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientStreetName | string | Optional.

    This field contains the street name of the recipient address. | No | | senderAccountNumber | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a financial instrument (for example, debit card), and if the SenderCardId attribute is not sent, this field is required and must contain the sender's account number.

    If the transaction is a funds disbursement, the field is not required. | No | | senderMiddleInitial | string | This field contains sender's middle initial | No | | recipientCountryCode | string | Conditional.

    This field contains the ISO 3166-1 country code of the recipient address.

    Refer to ISO Codes
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | transactionIdentifier | long | The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | recipientCardExpiryDate | string | The expiration date for the recipient's primary account number in recipientPrimaryAccountNumber | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | transactionCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. You should (unless prohibited by local law / regulation) use the billingCurrencyCode obtained from the Funds Transfer Attribute Inquiry API under Payment Account Attribute Inquiry.

    Refer to ISO Codes | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
    Note:
    If a currency has one decimal place, the last digit of this field must be zero.
    If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | recipientPrimaryAccountNumber | string | The recipient's PAN. | Yes | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address. | No | | senderIdentificationNumberBusiness | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements) | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains customer's VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | #### PullFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | This field will be present in a partially approved AFT transaction. It will contain the original transaction amount (i.e. the "amount" field value in the AFT request) . This amount will be represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | tokenData | { **"minimumAccountRange"**: integer, **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to actionCode | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN), when a token (instead of a PAN) is used in the transaction. | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | approvedAmount | double | This field will be present in a partially approved AFT transaction. It will contain the amount approved by the card issuer, and is represented in the transaction currency (i.e. senderCurrencyCode value in AFT request). | No | | cavvResultCode | string | The cavvResultCode identifies the outcome of the CAVV validation.

    Note: When using dual cryptograms (both TAVV and CAVV ), If TAVV is valid than cavvResultCode would convey the outcome of the CAVV validation.

    Refer to cavvResultCode | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | supplementalData | { **"dafIndicator"**: string } | This field will contain supplemental values for a transaction. | No | | customerReference | string | Conditional

    This field contains a value that identifies the customer. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | pointOfServiceData | { **"motoECIIndicator"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer.
    Note: The .SSS portion received in the PullFundsTransactions POST response will be ignored in the following ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request.
    Format: yyyy-MM-ddTHH:mm:ss.SSS
    Example: 2016-01-15T07:03:52.000Z | Yes | | riskAssessmentResults | { **"exemptionReasonCode"**: [ string ], **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | This object is present in the response only if the issuer supports SCA exemptions. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | reimbursementAttribute | string | Conditional
    If AFT transaction has qualified for CPS then this field contains a code that identifies the applicable interchange reimbursement fee. Possible values are : A (Payment Service Interchange Reimbursement Fee (PSIRF) U.S.).
    Please reach out to your Visa representative for details. | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | addressVerificationResults | string | Results of the Address Verification Service (AVS) validation for the Primary Account Number.
    Refer to addressVerificationResults
    *Example:* `"string"` | No | | senderIdentificationNumberIndividual | string | Conditional

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification. | No | | masterCardElectronicCommerceIndicators | string | This field contains the security-level indicator for Mastercard issuer-authenticated transactions. | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Indicates whether AFT transaction has qualified for CPS. Possible values are : F (Meets CPS/Account Funding requirements) , N (Not Qualified), T (Not Qualified).

    Note: Supported only in US for CPS (Custom Payment Service).
    Please reach out to your Visa representative for details. | No | #### MerchantPushPaymentPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | Transaction amount in merchant currency. | Yes | | senderName | string |
    The Sender Name can be up to 30 characters long and must be the sender's legal name. If the sender's name is greater than thirty (30) characters, use only the first 30 characters of the name.
    Populate with consumer name If consumer name is greater than 30 characters, use first 30 characters. The name must be populated using the Roman i.e., English character set.

    Recommended Format: \|Last Name/Family Surname 1 plus space \| Last Name/Family Surname 2(optional) plus space \| First Name plus space\| Middle Initial or Middle Name(optional)
    Note:

    - This field must not contain a ? (Question mark) or any special characters
    - Only a valid and legal recipient name must be populated in this field | Yes | | secondaryId | string | Conditional. If the merchant information display contains Additional Data - Value 2 then originator should populate this fields. See the example of the field purchaseIdentifier on how to extract this field value from QR. | No | | acquiringBin | string | BIN number identifies the originator of merchant payment transaction. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | | Yes | | senderReference | string | A reference number unique to the merchant. Field can be left blank. | No | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionFeeAmt | string | Conditional. In certain case the merchant display information could contain convenience fee applicable to the transaction. Originators are required to populate convenience fee amount in this field, if presented by merchant. | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | | No | | acquirerCountryCode | string | Country of the originator BIN. Use a 3-digit numeric country code for the country. Refer to [ISO Codes](/request_response_codes#iso_country_codes). | Yes | | senderAccountNumber | string | Populate with consumer PAN. If the consumer PAN is not populated or is not valid, VisaNet will reject the transaction with reject code 0494 (field or data missing or invalid) | Yes | | merchantCategoryCode | string | Numeric only. Originator should populate value captured from merchant displayed or a default value of 6012 for transaction initiated with manual entry of merchant ID. | Yes | | businessApplicationId | string | Use MP for merchant payment. This field is populated with business application identifier for the transaction. Refer to [businessApplicationId](/request_response_codes#businessApplicationId) codes | Yes | | systemsTraceAuditNumber | string | Numeric only. It is a key data element used to match a response to its request or to match a message to others for a given transaction. The value assigned to the original request should appear in all subsequent messages for that transaction. | Yes | | transactionCurrencyCode | string | The code in this field must always reflect the currency associated to the amount in field amount. Use a 3-digit numeric currency code for currency. Refer to [ISO Codes](/request_response_codes#currency_codes). | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | The date and time of the transaction takes place, expressed in the local date and time of the originator. | Yes | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. It is recommended that the client populate ydddhhnnnnnn value in this field. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | recipientPrimaryAccountNumber | string | Merchant PAN. 16-digit PAN created from the merchant ID as captured by the consumer from the merchant information display. | Yes | #### MerchandiseReturnTransactionPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | Refunded amount in original transaction currency. | Yes | | acquiringBin | string | This BIN number identifies the originator of refund transaction. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | This must be the same value as in the original response. | Yes | | cardExpiryDate | string | The expiration date for the Consumer PAN in recipientPrimaryAccountNumber | No | | memberSuppliedIRF | string | This field is only relevant for LAC regional markets where the acquirer to send interchange fee when refunding the amount back to the cardholder. List of Countries supported:
    1. Costa Rica
    2. Dominican Republican
    3. Venezuela
    4. Guatemala | No | | transactionFeeAmt | string | Prefix ‘C’ Originators are required to populate convenience fee amount in this field to be returned, if presented in the original message
    Note: The transactionFeeAmt should NOT be greater or equal to the amount (Refunded amount from original transaction) within the request above. | No | | acquirerCountryCode | string | Use a 3-digit numeric country code for the country. This must match the information provided during program enrollment. | Yes | | feeProgramIndicator | string | Originators can leave this field blank. | No | | merchantCategoryCode | string | This is to be populated with the MCC of the merchant initiating the refund. | Yes | | transactionIdentifier | string | Conditional. If originator submits merchant payment transaction using MerchantPushPayments API, they should submit the same value of transactionIdentifier in API request. Otherwise, do not use this field in the API request. | No | | reimbursementAttribute | string | This field contains a code that identifies the applicable interchange reimbursement fee for the transaction. Please contact your Regional Visa Client Support Services Representative to identify the value that you should be using. | No | | systemsTraceAuditNumber | string | Numeric only. This must be the same value as in the original request. | Yes | | transactionCurrencyCode | string | The code in this field must always reflect the currency associated to the amount | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | This should be +/- 3 days from the current date.The date is in yyyy-mm-ddThh:mm:ss format. | Yes | | retrievalReferenceNumber | string | Numeric only. This is a key data element for matching a message to others within a given transaction set.Recommended Format : ydddhhnnnnnnThe first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the SystemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | recipientPrimaryAccountNumber | string | Populate with Consumer PAN. This is the same PAN the consumer used in merchant payment. | Yes | #### GetAliasRequest-1 Schema Request object for get alias request. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute represents the unique id for a payment instrument belonging to a consumer cardholder. | Yes | #### GetAliasRequest-2 Schema Request object for get alias request. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder). | No | #### AliasInquiryDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasInquiryDetails | [ { **"alias"**: string, **"aliasType"**: string, **"paymentInstrOwner"**: string,
    **Available values:** "REQUESTOR", "OTHER", **"paymentInstrTypes"**: [ string ] } ] | | | #### MerchantPushPaymentPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | Transaction amount in merchant currency. | Yes | | senderName | string | Populate with consumer name If consumer name is greater than 30 characters, use first 30 characters. The name must be populated using the Roman i.e., English character set. | Yes | | secondaryId | string | Conditional. If the merchant information display contains Additional Data - Value 2 then originator should populate this fields. See the example of the field purchaseIdentifier on how to extract this field value from QR. | No | | acquiringBin | string | BIN number identifies the originator of merchant payment transaction. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | | Yes | | senderReference | string | A reference number unique to the merchant. Field can be left blank. | No | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionFeeAmt | string | Conditional. In certain case the merchant display information could contain convenience fee applicable to the transaction. Originators are required to populate convenience fee amount in this field, if presented by merchant. | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | | No | | acquirerCountryCode | string | Country of the originator BIN. Use a 3-digit numeric country code for the country. Refer to [ISO Codes](/request_response_codes#iso_country_codes). | Yes | | senderAccountNumber | string | Populate with consumer PAN. If the consumer PAN is not populated or is not valid, VisaNet will reject the transaction with reject code 0494 (field or data missing or invalid) | Yes | | merchantCategoryCode | string | Numeric only. Originator should populate value captured from merchant displayed or a default value of 6012 for transaction initiated with manual entry of merchant ID. | Yes | | businessApplicationId | string | Use MP for merchant payment. This field is populated with business application identifier for the transaction. Refer to [businessApplicationId](/request_response_codes#businessApplicationId) codes | Yes | | systemsTraceAuditNumber | string | Numeric only. It is a key data element used to match a response to its request or to match a message to others for a given transaction. The value assigned to the original request should appear in all subsequent messages for that transaction. | Yes | | transactionCurrencyCode | string | The code in this field must always reflect the currency associated to the amount in field amount. Use a 3-digit numeric currency code for currency. Refer to [ISO Codes](/request_response_codes#currency_codes). | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | The date and time of the transaction takes place, expressed in the local date and time of the originator. | Yes | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. It is recommended that the client populate ydddhhnnnnnn value in this field. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | recipientPrimaryAccountNumber | string | Merchant PAN. 16-digit PAN created from the merchant ID as captured by the consumer from the merchant information display. | Yes | #### CashInAdviceRequest Schema Request body for Receive Cash-In Advice API | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | agentCity | string | Agent city name. | Yes | | messageType | string | Possible values based on Message Type Identifier are:
    • 0200 : 'Recipient Timeout'
    • 0220 : 'Advice' (STIP decline advice)
    • 0210 : 'Reject' (VIP reject)
    | Yes | | encAgentName | string | Contains Agent’s Doing Business as name (25 characters only). If the name is greater than 25 characters then the first 25 characters are populated. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). | Yes | | responseCode | string | Contains a code (also known as 'Action Code') that defines the response to a request. Refer to actionCode. This field is to be sent as NULL when messageType is 0200 - Recipient Timeout. | No | | originatorBIN | string | This BIN number identifies the originator of Cash-In payment transaction. | Yes | | rejectionCode | string | Only populated if Advice message type is ‘Reject’. This field contains the VisaNet rejection code. | No | | authIdResponse | string | Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipient maintains uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. This field is to be sent as NULL if it is not populated. | No | | encConsumerPAN | string | Consumer PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionAmount | string | Transaction amount in local currency. mVisa program rules do not permit cross border cash deposit transactions. | Yes | | visaTransactionId | string | Numeric. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | localTransactionDate | string | It contains the local month and day on which the transaction was originated. The date is in mmdd format. | Yes | | localTransactionTime | string | The time the transaction takes place, expressed in the local time of the originator. The time is in hhmmss format. | Yes | | transmissionDateTime | string | The date and time the request was submitted to Visa. Format: MMDDhhmmss. | Yes | | originatorCountryCode | string | A 3-digit ISO-4217 code that identifies the country of the originating BIN.
    Refer to ISO codes. | Yes | | systemTraceAuditNumber | string | Numeric. It is a key data element used to match a response to its request or to match a message to others for a given transaction. | Yes | | velocityLimitIndicator | string | Conditional. This field contains the velocity limit related information that Acquirer can use in making the authorization decision:
    • 1 = 1-day count or amount exceeded.
    • 2 = 7-day count or amount exceeded.
    • 3 = 30-day count or amount exceeded.
    The field is populated with priority of 1, 2 and then 3.
    This field is sent if recipient has opted for VisaNet to forward them the OCT when a velocity limit has been exceeded.
    This field will be sent as NULL if it is not populated. | No | | transactionCurrencyCode | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the transactionAmount field. | Yes | | decimalPositionIndicator | string | Indicates the number of decimal positions following the amount field. This field is to be sent as NULL if it is not populated. | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | Numeric. It is a key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. The format is recommended to be ydddhhnnnnnn. | Yes | #### MultiPullFundsTransactionPostResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode
    *Example:* `"string"` | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### GenerateReportResponse-1 Schema Response if a report generation request is successfully processed. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | reportLocation | string | A URL link that contains a report ID and a page ID. Use GetReport API to navigate and download the report. | No | #### MultiPullFundsTransactionPostResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | Yes | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### GetMerchantAliasResponse-1 Schema Response data when a merchant or agent alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Merchant or agent city. | Yes | | email | string | Merchant or agent email address. | No | | phone | string | Merchant or agent phone number. | No | | aliasId | string | This attribute is uniquely used by Acquirer to identify their merchant or agent . | Yes | | country | string | Merchant or agent country code as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | Yes | | aliasType | string | 01 – Phone number
    02 – Email address
    03 – USSD Payment ID
    04 – BID (Bank Identification Number)
    05 – National ID
    06 – Custom
    Null – Should start with visa assigned USSD Payment ID | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | Yes | | postalCode | string | Merchant or agent postal code. | No | | recipientName | string | Merchant or agent name. | Yes | | convenienceFeeAmount | string | The convenience fee of a fixed amount. Applicable only for merchant alias. | No | | merchantCategoryCode | string | Merchant Category Code. Numeric only. | Yes | | payloadFormatIndicator | string | Defines the format of the merchant data payload. Payload Format Indicator must be set to '01' as per EMVCo Merchant Presented QR specifications. | Yes | | pointOfInitiationMethod | string | In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st character
    '1' = QR
    '2' = BLE
    '3' = NFC
    '4' - '9' = Reserved for Future Use
    2nd character
    '1' = Static
    '2' = Dynamic
    '3' - '9' = Reserved for Future Use.
    Example: '11' indicates QR static code, '12' indicates QR dynamic code. | No | | transactionCurrencyCode | string | As defined by ISO 4217. This is the transaction currency code that a merchant can accept for payment. 3-digit numeric presentation of the currency is recommended to be used if alias may be used for QR. | Yes | | convenienceFeePercentage | string | Applicable only for merchant alias. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). | No | | tipConvenienceFeeIndicator | string | Tip or Convenience Fee Indicator. This shall contains a value of '01', '02' or '03' as per EMVCo Merchant Presented QR specifications. Applicable only for merchant alias. | No | #### AliasInquiryRequest Schema Alias Inquiry Request Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | [ string ] | Aliases that needs to be inquired about. This attribute contains the Alias data, e.g. phone number, email address, etc.
    If phone number is used for Alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Up to 1000 Aliases are supported in the Alias Inquiry request. | Yes | | paymentInstrTypes | [ string ] | Identifies if the payment instrument returned should be CARD or ACCOUNT. By default the value is CARD. | No | #### AliasResolveRequest-1 Schema Alias Resolve Request Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | This attribute is used to retrieve recipient's Primary Account Number (PAN) of the card holder which can then be used in subsequent services such as Visa Direct.
    This attribute can contain information of a mobile phone number, email address, IBAN, merchant ID, etc.
    If phone number is used for Alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Ukraine38038067xxxxxxx
    Belarus37537529xxxxxxx
    Kazakhstan77701xxxxxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for Alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | | aliasType | string | Used to identify the type of Alias provided in the Alias field. Allowed Alias Types are as listed below
    01 - Phone Number
    02 - Email ID
    03 - National ID
    04 - IBAN | No | | accountLookUp | string | Retrieve the attributes that determine the key characteristics of a recipient payment account before initiating a funds transfer by providing the Primary Account Number (PAN).
    If such attributes are required, set the value as 'Y'. Default is set as 'N' | No | | businessApplicationId | string,
    **Available values:** "PP", "MP", "CO", "CI" | Used to identify program’s business application type for VisaNet transaction processing. It can be PP for Personal payment, MP for Merchant Payment, CO for Cash Out, CI for Cash In.

    In select countries where available, please use PP to search for an Alias in third party directories using the Alias Lookup API. Please contact your Visa representative for more information.
    *Enum:* `"PP"`, `"MP"`, `"CO"`, `"CI"` | Yes | #### MultiPushFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"amount"**: double, **"surcharge"**: string (double), **"senderCity"**: string, **"senderName"**: string, **"accountType"**: string, **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"sourceAmount"**: double, **"recipientCity"**: string, **"recipientName"**: string, **"senderAddress"**: string, **"recipientState"**: string, **"senderLastName"**: string, **"senderFirstName"**: string, **"senderReference"**: string, **"senderStateCode"**: string, **"purposeOfPayment"**: string, **"senderMiddleName"**: string, **"senderPostalCode"**: string, **"sharingGroupCode"**: string, **"customerReference"**: string, **"messageReasonCode"**: integer, **"recipientLastName"**: string, **"senderCountryCode"**: string, **"senderDateOfBirth"**: string, **"sourceOfFundsCode"**: string, **"purchaseIdentifier"**: { **"type"**: string, **"referenceNumber"**: string }, **"recipientFirstName"**: string, **"sourceCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"recipientMiddleName"**: string, **"recipientPostalCode"**: string, **"recipientStreetName"**: string, **"senderAccountNumber"**: string, **"senderMiddleInitial"**: string, **"recipientCountryCode"**: string, **"recipientAddressLine1"**: string, **"recipientAddressLine2"**: string, **"serviceProcessingType"**: { **"requestType"**: string }, **"transactionIdentifier"**: long, **"recipientMiddleInitial"**: string, **"merchantPseudoAbaNumber"**: string, **"recipientBuildingNumber"**: string, **"recipientCardExpiryDate"**: string, **"systemsTraceAuditNumber"**: integer, **"transactionCurrencyCode"**: string, **"enablerVerificationValue"**: string, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"settlementServiceIndicator"**: integer, **"recipientPrimaryAccountNumber"**: string, **"recipientSubDivisionMinorCode"**: string, **"senderIdentificationNumberBusiness"**: string, **"senderIdentificationNumberIndividual"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | messageReasonCode | integer | Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | merchantCategoryCode | integer | If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

    Refer to businessApplicationId codes | Yes | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | senderIdentificationNumberBusiness | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

    Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains the customer’s VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments),

    Note: If senderIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions.
    If businessApplicationId has PS, then this field to be populated for Argentina domestic transaction. | No | #### ReverseFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | No | | customerReference | string | This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic purchase transactions where businessApplicationId is "PS". | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction.
    Note:transactionIdentifier is a Visa generated field that client receives in the response message.
    Note:As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconcilation. | Yes | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions, where businessApplicationId is "PS", this field contains the customer’s VAT registration number for tax identification | No | #### CardAcceptor Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | Originator must populate this field with value captured from merchant information display. If manual entered transaction then populate default value of 'mVisa merchant'. | Yes | | idCode | string | Originator can populate the field with any system generated reference number internal to originating client. | Yes | | address | { **"city"**: string, **"country"**: string } | | No | #### ErrorResponseURL-1 Schema Error response data. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | url | string | Conditional. An URL of a landing page that contains participating issuers will be returned to originator if an alias cannot be found in Visa Alias Directory and HTTP status code = 404. Originator can notify unregistered recipient with this URL so that he/she can select preferred issuer for alias registration.
    Note:This attribute is only applicable to selective markets, contact Visa representative for details. | No | | reason | string | Conditional. Reason of the unexpected error. This attribute will not be returned if attribute 'url' is returned. | No | | message | string | Conditional. Error description of the unexpected error. This attribute will not be returned if attribute 'url' is returned. | No | #### AliasResolveRequest-2 Schema Alias Resolve Request Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | This attribute is used to retrieve recipient's Primary Account Number (PAN) of the card holder which can then be used in subsequent services such as Visa Direct.
    This attribute can contain information of a mobile phone number, email address, IBAN, merchant ID, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | | accountLookUp | string | Retrieve the attributes that determine the key characteristics of a recipient payment account before initiating a funds transfer by providing the Primary Account Number (PAN).
    If such attributes are required, set the value as 'Y'. Default is set as 'N' | No | | inviteSMSParameters | { **"amount"**: string, **"language"**: string, **"senderName"**: string } | Optional parameters to allow originator provide sender information to Visa for constructing notification message to be sent via SMS or other means to invite receiver registering their alias in the Alias Directory if the alias mapping cannot be found (i.e. HTTP Error 404 in RESOLVE API response). Note: This is only available in selected markets, please contact Visa's representative for details. | No | | businessApplicationId | string,
    **Available values:** "PP", "MP", "CO", "CI" | Used to identify program’s business application type for VisaNet transaction processing. It can be PP for Personal payment, MP for Merchant Payment, CO for Cash Out, CI for Cash In
    *Enum:* `"PP"`, `"MP"`, `"CO"`, `"CI"` | Yes | #### AliasResolveRequest-3 Schema Alias Resolve Request Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | This attribute is used to retrieve recipient's Primary Account Number (PAN) of the card holder which can then be used in subsequent services such as Visa Direct.
    This attribute can contain information of a mobile phone number, email address, IBAN, merchant ID, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | | accountLookUp | string | Retrieve the attributes that determine the key characteristics of a recipient payment account before initiating a funds transfer by providing the Primary Account Number (PAN).
    If such attributes are required, set the value as 'Y'. Default is set as 'N' | No | | inviteSMSParameters | { **"amount"**: string, **"language"**: string, **"senderName"**: string } | Optional parameters to allow originator provide sender information to Visa for constructing notification message to be sent via SMS or other means to invite receiver registering their alias in the Alias Directory if the alias mapping cannot be found (i.e. HTTP Error 404 in RESOLVE API response). Note: This is only available in selected markets, please contact Visa's representative for details. | No | | businessApplicationId | string,
    **Available values:** "PP", "MP", "CO", "CI" | Used to identify program’s business application type for VisaNet transaction processing. It can be PP for Personal payment, MP for Merchant Payment, CO for Cash Out, CI for Cash In
    *Enum:* `"PP"`, `"MP"`, `"CO"`, `"CI"` | Yes | #### PushFundsTransactionPostResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | number | Conditional.

    This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | persistentFX | { **"exchangeRate"**: number (bigDecimal), **"visaRateTableId"**: string, **"visaRateProvider"**: string } | | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response Code
    Note: : The VisaNet Response Source for the transaction | Yes | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode
    *Example:* `"string"` | No | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Note: Applicable only for Top Up Transactions | No | | settlementInfo | { **"settlementAmount"**: number (bigDecimal), **"settlementCurrencyCode"**: integer, **"settlementConversionRate"**: number (bigDecimal) } | Note:
    get the value in decimal values by combining rate value with rate decimal positions | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | Conditional This field will be part of response in case of time out scenarios and this field will be later used in GET pushfundstransactions call to see the status of original transaction that timed out. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the date and time the request is submitted to VisaNet.
    Format: yyyy-MM-ddTHH:mm:ss.SSS
    Example: 2018-11-09T22:52:46.000Z | Yes | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | number (int64) | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Refer to ISO Codes | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### MultiPushFundsTransactionPostResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | statusIdentifier | string | | Yes | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### MultiPushFundsTransactionPostResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode
    *Example:* `"string"` | No | | statusIdentifier | string | | Yes | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### PushFundsTransactionPostResponse-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | number | Conditional.

    This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. merchant. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | persistentFX | { **"exchangeRate"**: number (bigDecimal), **"visaRateTableId"**: string, **"visaRateProvider"**: string } | | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response Code
    Note: : The VisaNet Response Source for the transaction | Yes | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode | No | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Note: Applicable only for Top Up Transactions | No | | settlementInfo | { **"settlementAmount"**: number (bigDecimal), **"settlementCurrencyCode"**: integer, **"settlementConversionRate"**: number (bigDecimal) } | get the value in decimal values by combining rate value with rate decimal positions | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | Conditional This field will be part of response in case of time out scenarios and this field will be later used in GET pushfundstransactions call to see the status of original transaction that timed out. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the date and time the request is submitted to VisaNet.
    Format: yyyy-MM-ddTHH:mm:ss.SSS
    Example: 2018-11-09T22:52:46.000Z | Yes | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | number (int64) | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client receives in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Refer to ISO Codes | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | cardAuthenticationResults | string | A Visa-defined code indicating Online Card Authentication Method results. Refer to cardAuthenticationResults (https://developer.visa.com/request_response_codes#cardAuthenticationResults) | No | | integratedCircuitCardData | string | A blob containing the Chip card data in TLV format.
    *Example:* `"8201495F2A0201245F34010182021C008407A0000000031010950580000000009A031102249B0268009C01009F02060000000000009F03060000000000009F0607A00000000310109F0802008C9F0902008C9F100706010A039000009F1A0201249F2608423158936ED6C38F9F2701809F3303E0B0C89F34034103029F3501229F360200019F3704ACAC66E89F5800DF0100DF0200DF0400"` | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### PushFundsTransactionPostResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | number | Conditional.

    This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response Code
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Note: Applicable only for Top Up Transactions | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | Conditional This field will be part of response in case of time out scenarios and this field will be later used in GET pushfundstransactions call to see the status of original transaction that timed out. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the date and time the request is submitted to VisaNet.
    Format: yyyy-MM-ddTHH:mm:ss.SSS
    Example: 2018-11-09T22:52:46.000Z | Yes | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | number (int64) | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Refer to ISO Codes | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### PushFundsTransactionPostResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | number | Conditional.

    This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response Code
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Note: Applicable only for Top Up Transactions | No | | deferredOCTData | { **"requestType"**: string, **"deferredDateTime"**: string } | Requesting Visa to process the request as a deferred OCT transaction. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | Conditional This field will be part of response in case of time out scenarios and this field will be later used in GET pushfundstransactions call to see the status of original transaction that timed out. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the date and time the request is submitted to VisaNet.
    Format: yyyy-MM-ddTHH:mm:ss.SSS
    Example: 2018-11-09T22:52:46.000Z | Yes | | transactionIdentifier | number (int64) | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Refer to ISO Codes | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### MultiReverseFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"amount"**: double, **"networkId"**: integer, **"surcharge"**: string (double), **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"memberComments"**: string, **"senderReference"**: string, **"sharingGroupCode"**: string, **"merchantReference"**: string, **"pointOfServiceData"**: { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer }, **"senderCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"originalDataElements"**: { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer }, **"senderCardExpiryDate"**: string, **"transactionIdentifier"**: long, **"merchantPseudoAbaNumber"**: string, **"systemsTraceAuditNumber"**: integer, **"enablerVerificationValue"**: string, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"pointOfServiceCapability"**: { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer }, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"senderPrimaryAccountNumber"**: string, **"settlementServiceIndicator"**: integer, **"foreignExchangeFeeTransaction"**: double, **"senderIdentificationNumberBusiness"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country where the Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | merchantCategoryCode | integer | If original AFT found, then the value from AFT overrides the one present in the AFTR request. If the merchantCategoryCode value is not there in original AFT then this field is populated from AFTR request.

    If not present in AFT/AFTR, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    Refer to businessApplicationId codes | No | | localTransactionDateTime | dateTime | | Yes | #### CreateAliasRequest Schema Request payload data for creating an alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:

    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | | country | string | Consumer’s country code as defined by ISO 3166, ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | Yes | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum | Yes | | aliasType | string | “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | Yes | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM. | Yes | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Postal/Zip code of the consumer. | No | | paymentType | string | Only accept value 'PAN'. | No | | accountEmail | string | Conditional. This field should only be used for selected markets that opt to use Visa web portal for alias registration. This is a consumer email address for communications and matching purposes. If the account email does not match with existing alias mappings, the existing alias mappings will be disabled prior to creating the new alias mapping. | No | | contactEmail | string | Consumer’s contact email for communications. | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal data for VAD service. Format: YYYY-MM-DD hh:mm:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | Yes | | recipientLastName | string | Consumer’s last name. | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for communications | No | | recipientFirstName | string | Consumer’s first name. | Yes | | recipientMiddleName | string | Consumer’s middle name. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer's card number. | Yes | #### MultiPullFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"cavv"**: string, **"amount"**: double, **"pinData"**: { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } }, **"surcharge"**: string (double), **"senderCity"**: string, **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"cardCvv2Value"**: string, **"senderAddress"**: string, **"memberComments"**: string, **"recipientState"**: string, **"senderLastName"**: string, **"senderFirstName"**: string, **"senderReference"**: string, **"senderStateCode"**: string, **"senderPostalCode"**: string, **"sharingGroupCode"**: string, **"merchantReference"**: string, **"messageReasonCode"**: integer, **"recipientLastName"**: string, **"senderCountryCode"**: string, **"sourceOfFundsCode"**: string, **"magneticStripeData"**: { **"track1Data"**: string, **"track2Data"**: string }, **"pointOfServiceData"**: { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer }, **"recipientFirstName"**: string, **"riskAssessmentData"**: { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string }, **"senderCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"senderAccountNumber"**: string, **"senderMiddleInitial"**: string, **"recipientCountryCode"**: string, **"senderCardExpiryDate"**: string, **"originalTransactionId"**: integer, **"recipientMiddleInitial"**: string, **"visaMerchantIdentifier"**: string, **"addressVerificationData"**: { **"street"**: string, **"postalCode"**: string }, **"merchantPseudoAbaNumber"**: string, **"systemsTraceAuditNumber"**: integer, **"enablerVerificationValue"**: string, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"pointOfServiceCapability"**: { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer }, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"senderPrimaryAccountNumber"**: string, **"settlementServiceIndicator"**: integer, **"foreignExchangeFeeTransaction"**: double, **"recipientIdentificationNumberBusiness"**: string, **"recipientIdentificationNumberIndividual"**: string, **"cpsAuthorizationCharacteristicsIndicator"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | merchantCategoryCode | integer | Note: If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned). | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    Refer to businessApplicationId codes | No | | localTransactionDateTime | dateTime | | Yes | #### MultiPushFundsTransactionPostPayload-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"amount"**: double, **"surcharge"**: string (double), **"senderCity"**: string, **"senderName"**: string, **"accountType"**: string, **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"sourceAmount"**: double, **"recipientCity"**: string, **"recipientName"**: string, **"senderAddress"**: string, **"recipientState"**: string, **"senderLastName"**: string, **"senderFirstName"**: string, **"senderReference"**: string, **"senderStateCode"**: string, **"purposeOfPayment"**: string, **"senderMiddleName"**: string, **"senderPostalCode"**: string, **"sharingGroupCode"**: string, **"customerReference"**: string, **"messageReasonCode"**: integer, **"recipientLastName"**: string, **"senderCountryCode"**: string, **"senderDateOfBirth"**: string, **"sourceOfFundsCode"**: string, **"recipientFirstName"**: string, **"sourceCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"recipientMiddleName"**: string, **"recipientPostalCode"**: string, **"recipientStreetName"**: string, **"senderAccountNumber"**: string, **"senderMiddleInitial"**: string, **"recipientCountryCode"**: string, **"recipientAddressLine1"**: string, **"recipientAddressLine2"**: string, **"transactionIdentifier"**: long, **"recipientMiddleInitial"**: string, **"merchantPseudoAbaNumber"**: string, **"recipientBuildingNumber"**: string, **"recipientCardExpiryDate"**: string, **"systemsTraceAuditNumber"**: integer, **"transactionCurrencyCode"**: string, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"settlementServiceIndicator"**: integer, **"recipientPrimaryAccountNumber"**: string, **"recipientSubDivisionMinorCode"**: string, **"senderIdentificationNumberBusiness"**: string, **"senderIdentificationNumberIndividual"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | messageReasonCode | integer | Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | merchantCategoryCode | integer | If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

    Refer to businessApplicationId codes | Yes | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | senderIdentificationNumberBusiness | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

    Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains the customer’s VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments),

    Note: If senderIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions.
    If businessApplicationId has PS, then this field to be populated for Argentina domestic transaction. | No | #### CashOutResponse Schema Response body for Receive Cash-Out API | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | agentCity | string | Agent city name.
    If encounter errors or the agent PAN is invalid/does not belong to the acquirer, the acquirer should send HTTP 200 with decline response code and echo back the same field content sent in the request.
    Note:This field, if present, should be sent together with agentCountryCode and agentName. Otherwise none of them should be sent in the response. | No | | agentName | string | Contains Agent’s Doing Business as name (25 characters only). If the name is greater than 25 characters then the first 25 characters are populated.
    If encounter errors or the agent PAN is invalid/does not belong to the acquirer, the acquirer should send HTTP 200 with decline response code and echo back the same field content sent in the request.
    Note:This field, if present, should be sent together with agentCountryCode and agentCity. Otherwise none of them should be sent in the response. | No | | responseCode | string | Contains a code (also known as 'Action Code') that defines the response to a request. Refer to actionCode | Yes | | authIdResponse | string | Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipient maintains uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. This field is to be sent as NULL if it is not populated. | No | | agentCountryCode | string | Conditional. Recipient may replace this field with 2-letter ISO 3166 country code of the agent, if different than the value provided by the originator. Visa settlement reports would contain the value provided by recipient. This field is to be sent as NULL if it is not populated.
    Note:This field, if present, should be sent together with agentName and agentCity. Otherwise none of them should be sent in the response. | No | | receiverTransactionId | string | Acquirer may provide a transaction ID that can be used for investigation if required. This field is to be sent as NULL if it is not populated | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | #### PersonToMerchantRequest Schema Request body for Receive Person-to-Merchant API | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | refId | string | Conditional. This field is sent if it is reflected in the merchant information display. It will otherwise be sent as NULL if it is not populated. | No | | billId | string | Conditional. This is the invoice number or some other reference for billing purposes. This field will be sent as NULL if it is not populated. | No | | billIdFormat | string | Conditional. Populate 0 (Primary ID, as defined by mVisa)
    This field will be sent as NULL if it is not populated. | No | | originatorBIN | string | This BIN number identifies the originator of merchant payment transaction. | Yes | | encConsumerPAN | string | Consumer PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM) ) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | encMerchantPAN | string | Merchant PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | encConsumerName | string | Consumer name. If consumer name is greater than 30 characters, then only first 30 characters will be expected. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). | No | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionAmount | string | Transaction amount in merchant currency. The value in this field includes tip or convenience fees, if applicable. | Yes | | visaTransactionId | string | Numeric. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | localTransactionDate | string | It contains the local month and day on which the transaction was originated. The date is in mmdd format. | Yes | | localTransactionTime | string | The time the transaction takes place, expressed in the local time of the originator. The time is in hhmmss format. | Yes | | transactionFeeAmount | string | Conditional. In certain case the merchant display information could contain convenience fee applicable to the transaction. Originators are required to populate convenience fee amount in this field, if presented by merchant. This field will be sent as NULL if it is not populated. | No | | transmissionDateTime | string | The date and time the request was submitted to Visa. Format: MMDDhhmmss. | Yes | | originatorCountryCode | string | A 3-digit ISO-4217 code that identifies the country of the originating BIN.
    Refer to ISO codes. | Yes | | systemTraceAuditNumber | string | Numeric. It is a key data element used to match a response to its request or to match a message to others for a given transaction. | Yes | | velocityLimitIndicator | string | Conditional. This field contains the velocity limit related information that Acquirer can use in making the authorization decision:
    • 1 = 1-day count or amount exceeded.
    • 2 = 7-day count or amount exceeded.
    • 3 = 30-day count or amount exceeded.
    The field is populated with priority of 1, 2 and then 3.
    This field is sent if recipient has opted for VisaNet to forward them the OCT when a velocity limit has been exceeded.
    This field will be sent as NULL if it is not populated. | No | | transactionCurrencyCode | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the transactionAmount field. | Yes | | decimalPositionIndicator | string | Indicates the number of decimal positions following the amount field. This field is to be sent as NULL if it is not populated. | Yes | | retrievalReferenceNumber | string | Numeric. It is a key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. The format is recommended to be ydddhhnnnnnn. | Yes | #### PushFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | number | Conditional.

    This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | persistentFX | { **"exchangeRate"**: number (bigDecimal), **"visaRateTableId"**: string, **"visaRateProvider"**: string } | | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response Code
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Note: Applicable only for Top Up Transactions | No | | settlementInfo | { **"settlementAmount"**: number (bigDecimal), **"settlementCurrencyCode"**: integer, **"settlementConversionRate"**: number (bigDecimal) } | Note:
    get the value in decimal values by combining rate value with rate decimal positions | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | Conditional This field will be part of response in case of time out scenarios and this field will be later used in GET pushfundstransactions call to see the status of original transaction that timed out. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | This field contains the date and time the request is submitted to VisaNet.
    Format: yyyy-MM-ddTHH:mm:ss.SSS
    Example: 2018-11-09T22:52:46.000Z | Yes | | serviceProcessingType | { **"requestType"**: string, **"deferredDateTime"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | number (int64) | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Refer to ISO Codes | No | | additionalTokenRespInfo | string | This field when present in the API response identifies if the transaction is eligible for token services. Valid token service values are: 1 (Token program).

    This field will not be sent in the response if the transaction is ineligible for token services. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### GetAliasRequest Schema Request object for get alias request. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder). | No | #### CashOutAdviceRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | agentCity | string | Agent city name. | Yes | | encAgentPAN | string | Agent PAN. 16-digit PAN as created from the mVisa agent ID captured by the consumer from agent information display option. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | messageType | string | Possible values based on Message Type Identifier are:
    • 0200 : 'Recipient Timeout'
    • 0220 : 'Advice' (STIP decline advice)
    • 0210 : 'Reject' (VIP reject)
    | Yes | | encAgentName | string | Contains Agent’s Doing Business as name (25 characters only). If the name is greater than 25 characters then the first 25 characters are populated. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). | Yes | | responseCode | string | Contains a code (also known as 'Action Code') that defines the response to a request. Refer to actionCode. This field is to be sent as NULL when messageType is 0200 - Recipient Timeout. | No | | originatorBIN | string | This BIN number identifies the originator of Cash-Out payment transaction. | Yes | | rejectionCode | string | Only populated if Advice message type is ‘Reject’. This field contains the VisaNet rejection code. | No | | authIdResponse | string | Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipient maintains uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. This field is to be sent as NULL if it is not populated. | No | | encConsumerPAN | string | Consumer PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | No | | encConsumerName | string | Consumer name. If consumer name is greater than 30 characters, then only first 30 characters will be expected. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). | Yes | | agentCountryCode | string | Conditional. Recipient may replace this field with 2-letter ISO 3166 country code of the agent, if different than the value provided by the originator. Visa settlement reports would contain the value provided by recipient. This field is to be sent as NULL if it is not populated. | No | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionAmount | string | Transaction amount in agent on currency. In case the agent currency is not the same as the consumer currency, then originator will perform currency conversion before submitting the transaction. | Yes | | visaTransactionId | string | Numeric. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | localTransactionDate | string (mmdd) | It contains the local month and day on which the transaction was originated. The date is in mmdd format. | Yes | | localTransactionTime | string (hhmmss) | The time the transaction takes place, expressed in the local time of the originator. The time is in hhmmss format. | Yes | | transmissionDateTime | string (MMDDhhmmss) | The date and time the request was submitted to Visa. Format: MMDDhhmmss. | Yes | | originatorCountryCode | string | A 3-digit ISO-4217 code that identifies the country of the originating BIN.
    Refer to ISO codes. | Yes | | systemTraceAuditNumber | string | Numeric. It is a key data element used to match a response to its request or to match a message to others for a given transaction. | Yes | | velocityLimitIndicator | string | Conditional. This field contains the velocity limit related information that Acquirer can use in making the authorization decision:
    • 1 = 1-day count or amount exceeded.
    • 2 = 7-day count or amount exceeded.
    • 3 = 30-day count or amount exceeded.
    The field is populated with priority of 1, 2 and then 3.
    This field is sent if recipient has opted for VisaNet to forward them the OCT when a velocity limit has been exceeded.
    This field will be sent as NULL if it is not populated. | No | | transactionCurrencyCode | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the transactionAmount field. | Yes | | decimalPositionIndicator | string | Indicates the number of decimal positions following the amount field. This field is to be sent as NULL if it is not populated. | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | Numeric. It is a key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. The format is recommended to be ydddhhnnnnnn. | Yes | #### IntegratedCircuitCardDataV2V2 Schema A blob containing the Chip card data in TLV format. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | IntegratedCircuitCardDataV2V2 | string | A blob containing the Chip card data in TLV format. | | **Example** 
    8201495F2A0201245F34010182021C008407A0000000031010950580000000009A031102249B0268009C01009F02060000000000009F03060000000000009F0607A00000000310109F0802008C9F0902008C9F100706010A039000009F1A0201249F2608423158936ED6C38F9F2701809F3303E0B0C89F34034103029F3501229F360200019F3704ACAC66E89F5800DF0100DF0200DF0400
    #### AliasResolveResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | City of the recipient. Recipient can be a consumer, merchant or agent. | No | | country | string | Country code of the recipient. As defined by ISO 3166. For aliases created after the September 2023 release, country will be returned in ISO3166-Alpha3 format for resolve response. For aliases created before the September 2023 release, country will be returned in whatever format was provided at the time of the Alias creation. | Yes | | address1 | string | Address of the recipient (line 1) | No | | address2 | string | Address of the recipient continued (line 2) | No | | cardType | string | Conditional. Card type description. Reference to Field 62.23 — Product ID of available card products. e.g. Visa Platinum. Only applicable if businessApplicationId = “PP” or “CI” | No | | issuerName | string | Conditional. This is the issuer name of recipient’s card. Only applicable if businessApplicationId = “PP” or “CI” | No | | postalCode | string | Postal Code of the recipient. Recipient can be a consumer, merchant or agent. | No | | recipientName | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer name, merchant name or agent name. Regarding consumer name, this is composed of consumer’s first, middle and last name. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | Yes | | accountLookUpInfo | { **"visaNetworkInfo"**: [ { **"issuerName"**: string, **"cardTypeCode"**: string, **"tokenIndicator"**: string, **"geoRestrictionInd"**: string, **"fastFundsIndicator"**: string, **"billingCurrencyCode"**: integer, **"cardIssuerCountryCode"**: string, **"pushFundsBlockIndicator"**: string, **"onlineGambingBlockIndicator"**: string, **"billingCurrencyCodeMinorDigits"**: string } ] } | | No | | recipientNameLocal | string | If available, this is composed of consumer’s first, middle and last name in local language. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | No | | convenienceFeeAmount | string | Conditional. The convenience fee of a fixed amount. The format of the amount is the same as defined in tag 54. Convenience amount as provided by merchant shall be passed in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | merchantCategoryCode | string | Conditional. Merchant Category Code. This attribute will only be returned if businessApplicationId=MP, CO | No | | pointOfInitiationMethod | string | Conditional. In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st Character:
    “1” = QR
    “2” = BLE
    “3” = NFC
    “4”-“9” = Reserved for future use

    2nd Character:
    “1” = Static
    “2” = Dynamic
    “3”-“9” = Reserved for future use

    Example: “11” indicates QR static code, “12” indicates QR dynamic code
    This attribute will only be returned if businessApplicationId=MP, CO | No | | transactionCurrencyCode | string | Conditional. This is the transaction currency code that a merchant can accept for payment. This attribute will only be returned if businessApplicationId=MP, CO. As defined by ISO 4217. | No | | convenienceFeePercentage | string | Conditional. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). Originators are required to derive the convenience fee amount and shall pass it in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | tipConvenienceFeeIndicator | string | Conditional. Tip or Convenience Fee Indicator. This attribute will only be returned if businessApplicationId=MP. | No | | recipientPrimaryAccountNumber | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer card number, mVisa merchant ID (16-digit) or mVisa agent ID (16-digit). | Yes | #### CashOutPushPaymentResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | Contains a code that defines the response to a request.
    Refer to actionCode | Yes | | approvalCode | string | Conditional. Contains the authorization code provided by the participant when a transaction is approved. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | It is optional for recipient to send card acceptor field in the response. However, if it is in the response, all merchant name, city and country need to be there. | No | | responseCode | string | It is added by VisaNet and contains the response source/reason code that identifies the source of the field actionCode response decision. | Yes | | statusIdentifier | string | Required when API response times out. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | transmissionDateTime | dateTime | The value in response must match the value in the request. | Yes | | transactionIdentifier | string | It is added by VisaNet. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. Value will be the same as what has been provided in the request. | Yes | #### MultiPushFundsTransactionPostPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | request | [ { **"amount"**: double, **"surcharge"**: string (double), **"senderCity"**: string, **"senderName"**: string, **"accountType"**: string, **"cardAcceptor"**: { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string }, **"sourceAmount"**: double, **"cardCvv2Value"**: string, **"recipientCity"**: string, **"recipientName"**: string, **"senderAddress"**: string, **"recipientState"**: string, **"senderLastName"**: string, **"senderFirstName"**: string, **"senderReference"**: string, **"senderStateCode"**: string, **"purposeOfPayment"**: string, **"senderMiddleName"**: string, **"senderPostalCode"**: string, **"sharingGroupCode"**: string, **"customerReference"**: string, **"messageReasonCode"**: integer, **"recipientLastName"**: string, **"senderCountryCode"**: string, **"senderDateOfBirth"**: string, **"sourceOfFundsCode"**: string, **"purchaseIdentifier"**: { **"type"**: string, **"referenceNumber"**: string }, **"recipientFirstName"**: string, **"sourceCurrencyCode"**: string, **"feeProgramIndicator"**: string, **"recipientMiddleName"**: string, **"recipientPostalCode"**: string, **"recipientStreetName"**: string, **"senderAccountNumber"**: string, **"senderMiddleInitial"**: string, **"recipientCountryCode"**: string, **"recipientAddressLine1"**: string, **"recipientAddressLine2"**: string, **"serviceProcessingType"**: { **"requestType"**: string }, **"transactionIdentifier"**: long, **"recipientMiddleInitial"**: string, **"merchantPseudoAbaNumber"**: string, **"recipientBuildingNumber"**: string, **"recipientCardExpiryDate"**: string, **"systemsTraceAuditNumber"**: integer, **"transactionCurrencyCode"**: string, **"enablerVerificationValue"**: string, **"localTransactionDateTime"**: dateTime, **"nationalReimbursementFee"**: double, **"retrievalReferenceNumber"**: string, **"argentinaReimbursementFee"**: double, **"merchantVerificationValue"**: { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string }, **"settlementServiceIndicator"**: integer, **"recipientPrimaryAccountNumber"**: string, **"recipientSubDivisionMinorCode"**: string, **"senderIdentificationNumberBusiness"**: string, **"senderIdentificationNumberIndividual"**: string } ] | | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | messageReasonCode | integer | Contains codes that combined with some other fields such as the BAI (Business Application Id) identify some unique use cases. For Sales Tax rebates this field should be populated with the value 5120 (Value-added tax/Sales Tax) along with the businessApplicationId field set to the value 'FD' which indicates this push funds transfer is being conducted in order to facilitate a sales tax refund. | No | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | merchantCategoryCode | integer | If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned)Note: required if not provided during onboarding | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Money Transfer, CD (Cash Deposit) applies to cash funded transactions.

    Refer to businessApplicationId codes | Yes | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | senderIdentificationNumberBusiness | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity. This field is to be used if the sender is a business (e.g. Disbursements)

    Note: If senderIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that carries the sender's identification number issued to the sender by the government or an authorized national entity or contains the customer’s VAT registration number for the individual tax identification. This field is to be used if the sender is an Individual (e.g. P2P payments),

    Note: If senderIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic transactions.
    If businessApplicationId has PS, then this field to be populated for Argentina domestic transaction. | No | #### AliasResolveResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | url | string | Optional. An URL of a landing page that contains participating issuers will be returned to originator if an alias cannot be found in Visa Alias Directory and HTTP status code = 404. Originator can notify unregistered recipient with this URL so that he/she can select preferred issuer for alias registration.
    Note:This attribute is only applicable to selective markets, originator will receive this URL instead of error JSON response for processing if HTTP status code = 404. Contact Visa's representative for details. | No | | city | string | City of the recipient. Recipient can be a consumer, merchant or agent. | No | | country | string | Country code of the recipient. As defined by ISO 3166. | Yes | | cardType | string | Conditional. Card type description. Reference to Field 62.23 — Product ID of available card products. e.g. Visa Platinum. Only applicable if businessApplicationId = “PP” or “CI” | No | | expiryDate | string | Conditional. Card expiration date.
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | issuerName | string | Conditional. This is the issuer name of recipient’s card. Only applicable if businessApplicationId = “PP” or “CI” | No | | postalCode | string | Postal Code of the recipient. Recipient can be a consumer, merchant or agent. | No | | recipientName | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer name, merchant name or agent name. Regarding consumer name, this is composed of consumer’s first, middle and last name | Yes | | accountLookUpInfo | { **"issuerName"**: string, **"cardTypeCode"**: string, **"geoRestrictionInd"**: string, **"fastFundsIndicator"**: string, **"billingCurrencyCode"**: integer, **"cardIssuerCountryCode"**: string, **"pushFundsBlockIndicator"**: string, **"onlineGambingBlockIndicator"**: string, **"billingCurrencyCodeMinorDigits"**: string } | | No | | recipientNameLocal | string | This attribute contains the consumer name in the local language, if one is defined in the consumer's profile | No | | convenienceFeeAmount | string | Conditional. The convenience fee of a fixed amount. The format of the amount is the same as defined in tag 54. Convenience amount as provided by merchant shall be passed in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | merchantCategoryCode | string | Conditional. Merchant Category Code. This attribute will only be returned if businessApplicationId=MP, CO | No | | pointOfInitiationMethod | string | Conditional. In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st Character:
    “1” = QR
    “2” = BLE
    “3” = NFC
    “4”-“9” = Reserved for future use

    2nd Character:
    “1” = Static
    “2” = Dynamic
    “3”-“9” = Reserved for future use

    Example: “11” indicates QR static code, “12” indicates QR dynamic code
    This attribute will only be returned if businessApplicationId=MP, CO | No | | transactionCurrencyCode | string | Conditional. This is the transaction currency code that a merchant can accept for payment. This attribute will only be returned if businessApplicationId=MP, CO. As defined by ISO 4217. | No | | convenienceFeePercentage | string | Conditional. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). Originators are required to derive the convenience fee amount and shall pass it in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | tipConvenienceFeeIndicator | string | Conditional. Tip or Convenience Fee Indicator. This attribute will only be returned if businessApplicationId=MP. | No | | recipientPrimaryAccountNumber | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer card number, mVisa merchant ID (16-digit) or mVisa agent ID (16-digit). | Yes | #### AdditionalPOSInformation Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | chipConditionCode | integer | This field applies to magnetic stripe read transactions where the card and terminal are chip capable. The field does not apply to VSDC transactions where the chip is read; it is used only when the chip card's magnetic stripe is read instead of the chip.
    Valid values include:

    0 - Not applicable to fallback transactions. For chip read transactions this field must contain a 0 or be excluded from the message.
    1 - This value applies to fallback transactions. Transaction was initiated from a magnetic stripe with a service code beginning with 2 or 6 and the last read at VSDC terminal was a successful chip read or was not a chip transaction.
    2 - This value applies to fallback transactions. Transaction was initiated at a chip-capable terminal from a magnetic stripe that contains service code 2 or 6, and the previous transaction initiated by that terminal was an unsuccessful chip read. | No | | chipTransactionIndicator | integer | This 1-digit code is set by full VSDC data acquirers when they receive a message from the terminal that indicates a chip-based transaction. | No | | chipAuthenticationReliabilityIndicator | integer | This 1-digit code can be set and sent in by the full VSDC data acquirer or set by Visa when the acquirer or issuer is inactive for Card Authentication. | No | #### AliasResolveResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | url | string | Optional. An URL of a landing page that contains participating issuers will be returned to originator if an alias cannot be found in Visa Alias Directory and HTTP status code = 404. Originator can notify unregistered recipient with this URL so that he/she can select preferred issuer for alias registration.
    Note:This attribute is only applicable to selective markets, originator will receive this URL instead of error JSON response for processing if HTTP status code = 404. Contact Visa's representative for details. | No | | city | string | City of the recipient. Recipient can be a consumer, merchant or agent. | No | | country | string | Country code of the recipient. As defined by ISO 3166. | Yes | | cardType | string | Conditional. Card type description. Reference to Field 62.23 — Product ID of available card products. e.g. Visa Platinum. Only applicable if businessApplicationId = “PP” or “CI” | No | | expiryDate | string | Card expiration date. | Yes | | issuerName | string | Conditional. This is the issuer name of recipient’s card. Only applicable if businessApplicationId = “PP” or “CI” | No | | postalCode | string | Postal Code of the recipient. Recipient can be a consumer, merchant or agent. | No | | recipientName | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer name, merchant name or agent name. Regarding consumer name, this is composed of consumer’s first, middle and last name | Yes | | accountLookUpInfo | { **"issuerName"**: string, **"cardTypeCode"**: string, **"geoRestrictionInd"**: string, **"fastFundsIndicator"**: string, **"billingCurrencyCode"**: integer, **"cardIssuerCountryCode"**: string, **"pushFundsBlockIndicator"**: string, **"onlineGambingBlockIndicator"**: string, **"billingCurrencyCodeMinorDigits"**: string } | | No | | recipientNameLocal | string | This attribute contains the consumer name in the local language, if one is defined in the consumer's profile | No | | convenienceFeeAmount | string | Conditional. The convenience fee of a fixed amount. The format of the amount is the same as defined in tag 54. Convenience amount as provided by merchant shall be passed in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | merchantCategoryCode | string | Conditional. Merchant Category Code. This attribute will only be returned if businessApplicationId=MP, CO | No | | pointOfInitiationMethod | string | Conditional. In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st Character:
    “1” = QR
    “2” = BLE
    “3” = NFC
    “4”-“9” = Reserved for future use

    2nd Character:
    “1” = Static
    “2” = Dynamic
    “3”-“9” = Reserved for future use

    Example: “11” indicates QR static code, “12” indicates QR dynamic code
    This attribute will only be returned if businessApplicationId=MP, CO | No | | transactionCurrencyCode | string | Conditional. This is the transaction currency code that a merchant can accept for payment. This attribute will only be returned if businessApplicationId=MP, CO. As defined by ISO 4217. | No | | convenienceFeePercentage | string | Conditional. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). Originators are required to derive the convenience fee amount and shall pass it in Field 28 of ISO or transactionFeeAmt of API message, in the Visa specifications. This attribute will only be returned if businessApplicationId=MP. | No | | tipConvenienceFeeIndicator | string | Conditional. Tip or Convenience Fee Indicator. This attribute will only be returned if businessApplicationId=MP. | No | | recipientPrimaryAccountNumber | string | Depending on the businessApplicationId of the request, this attribute can contain the consumer card number, mVisa merchant ID (16-digit) or mVisa agent ID (16-digit). | Yes | #### OriginalDataElements Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | acquiringBin | integer | This field must match with the BIN previously sent in the original refund transaction. | Yes | | approvalCode | string | This field, if present, must contain the approvalCode from the original refund transaction. | No | | transmissionDateTime | string | This field must contain the transmissionDateTime from the original refund transaction. | Yes | | systemsTraceAuditNumber | integer | This field must contain with the systemsTraceAuditNumber previously sent in the original refund transaction. | Yes | #### aliases Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | Conditional. This attribute contains the alias data, e.g. phone number, email address, etc.
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | | aliasType | string | Conditional.
    “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number).
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | | isDefault | string | Conditional. This attributes contains whether or not this is the default account to receive money.
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | Yes | #### PurchaseIdentifier Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | Populate 0 | Yes | | referenceNumber | string | Populate this field with the Additional Data - Value 1 as defined in merchant data specification with reference to EMVCo QR specification (Merchant-Presented Mode).
    Below is an example of Additional Data Field Template '62' having a value of '62150103XYZ05049999'
    IDDescriptonValueComments
    '62'-'01'Bill NumberXYZAdditional Data - Value 1
    '62'-'05'Reference Label9999Additional Data - Value 2
    | Yes | #### CreateAliasRequest-1 Schema Request payload data for creating an alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:

    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | | country | string | Consumer’s country code as defined by ISO 3166, ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | Yes | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum | Yes | | aliasType | string | “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | Yes | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM. | Yes | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Postal/Zip code of the consumer. | No | | paymentType | string | Only accept value 'PAN'. | No | | accountEmail | string | Conditional. This field should only be used for selected markets that opt to use Visa web portal for alias registration. This is a consumer email address for communications and matching purposes. If the account email does not match with existing alias mappings, the existing alias mappings will be disabled prior to creating the new alias mapping. | No | | contactEmail | string | Consumer’s contact email for communications. | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal data for VAD service. Format: YYYY-MM-DD hh:mm:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | Yes | | recipientLastName | string | Consumer’s last name. | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for communications | No | | recipientFirstName | string | Consumer’s first name. | Yes | | recipientMiddleName | string | Consumer’s middle name. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer's card number. | Yes | #### GetReportResponse Schema Response data when a merchant or agent alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | _links | { **"last"**: string, **"next"**: string, **"self"**: string, **"first"**: string, **"previous"**: string } | This contains the navigation url links of the report, i.e. 'self', 'first', 'next'(if applicable),'previous'(if applicable),'last'(if applicable). | Yes | | content | { **"guid"**: string, **"status"**: string, **"aliasId"**: string, **"merchantId"**: string, **"statusChangeDateTime"**: string } | Depending on the selected type of alias reports, this contains a list of consumer, merchant or agent alias records. | Yes | #### CashOutPushPaymentPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | Transaction amount in merchant currency. | Yes | | senderName | string |
    The Sender Name can be up to 30 characters long and must be the sender's legal name. If the sender's name is greater than thirty (30) characters, use only the first 30 characters of the name.
    Populate with consumer name If consumer name is greater than 30 characters, use first 30 characters. The name must be populated using the Roman i.e., English character set.

    Recommended Format: \|Last Name/Family Surname 1 plus space \| Last Name/Family Surname 2(optional) plus space \| First Name plus space\| Middle Initial or Middle Name(optional)
    Note:

    - This field must not contain a ? (Question mark) or any special characters
    - Only a valid and legal recipient name must be populated in this field | Yes | | acquiringBin | string | BIN number identifies the originator of cash-out transaction. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | | Yes | | senderReference | string | A reference number unique to the merchant. Field can be left blank. | No | | acquirerCountryCode | string | Use a 3-digit numeric country code for the country where the Visa Direct solution is registered. This must match the information provided during program enrollment. Refer to [ISO Codes](/request_response_codes#iso_country_codes). | Yes | | senderAccountNumber | string | Populate with consumer PAN. If the consumer PAN is not populated or is not valid or contains extra spaces, VisaNet will reject the transaction with reject code 494 (Field or data missing or invalid) | Yes | | merchantCategoryCode | string | Numeric only. Originators should populate 6012. If this field is not populated by the originator, it will automatically be set to the MCC value indicated during the API onboarding process. Recipient should populate the MCC of the merchant in the response message. | Yes | | businessApplicationId | string | Use CO (cash-out). This field is populated with business application identifier for the transaction. Refer to [businessApplicationId](/request_response_codes#businessApplicationId) codes | Yes | | systemsTraceAuditNumber | string | Numeric only. It is a key data element used to match a response to its request or to match a message to others for a given transaction. The value assigned to the original request should appear in all subsequent messages for that transaction | Yes | | transactionCurrencyCode | string | The code in this field must always reflect the currency associated to the amount in field Amount. Use a 3-digit numeric currency code for currency. Refer to [ISO Codes](/request_response_codes#currency_codes). | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | The date and time the transaction takes place, expressed in the local date and time of the originator. | Yes | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. It is recommended that the client populate ydddhhnnnnnn value in this field. | Yes | | recipientPrimaryAccountNumber | string | Consumer PAN. 16-digit PAN as provided by the consumer to merchant. | Yes | #### DeleteMerchantAliasRequest Schema Request payload data for deleting an merchant or agent alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasId | string | This attribute is uniquely used by acquirer to identify their merchant or agent. | Yes | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | Yes | | isAgentAlias | string | Optional and applicable for agent alias use only. If set as 'Y', agent alias to be created. | No | #### ErrorResponse-1 Schema Error response data. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | reason | string | Reason of the unexpected error. | No | | message | string | Error description of the unexpected error. | No | #### GenerateReportResponse Schema Response if a report generation request is successfully processed. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | reportLocation | string | A URL link that contains a report ID and a page ID. Use GetReport API to navigate and download the report. | No | #### ReverseFundsTransactionGetResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | feeProgramIndicator | object | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52:000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### ReverseFundsTransactionGetResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | feeProgramIndicator | object | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52:000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### ReverseFundsTransactionGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | object | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52:000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### CardAcceptormrr Schema This must be the same value as in the original response. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | This must be the same value as in the original response. | No | | idCode | string | This field must match with the Id Code previously sent in the original refund transaction. | No | | address | { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string } | | No | | terminalId | string | Conditional. Originators can drop this field only when the acquiring BIN is mVisa enabled. | No | #### CashInCardAcceptorAddress Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Include merchant city name. | Yes | | country | string | Must include the 2-character alpha country code of the originator. | Yes | #### MultiPushFundsTransactionPostResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | statusIdentifier | string | | Yes | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### PushFundsTransactionGetResponse-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. merchant. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | persistentFX | { **"exchangeRate"**: number (bigDecimal), **"visaRateTableId"**: string, **"visaRateProvider"**: string } | | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response code
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | double | Min Inclusive: -999999999.999
    Max Inclusive: 999999999.999
    Applicable only for Top Up Transactions | No | | settlementInfo | { **"settlementAmount"**: number (bigDecimal), **"settlementCurrencyCode"**: integer, **"settlementConversionRate"**: number (bigDecimal) } | get the value in decimal values by combining rate value with rate decimal positions | No | | deferredOCTData | { **"requestType"**: string, **"deferredDateTime"**: string } | Requesting Visa to process the request as a deferred OCT transaction. | No | | statusIdentifier | string | required when call times out | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Applicable only for Top Up Transactions | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### PushFundsTransactionGetResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response code
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999
    Max Inclusive: 999999999.999
    Applicable only for Top Up Transactions | No | | deferredOCTData | { **"requestType"**: string, **"deferredDateTime"**: string } | Requesting Visa to process the request as a deferred OCT transaction. | No | | statusIdentifier | string | required when call times out | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Applicable only for Top Up Transactions | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | #### PushFundsTransactionGetResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response code
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999
    Max Inclusive: 999999999.999
    Applicable only for Top Up Transactions | No | | deferredOCTData | { **"requestType"**: string, **"deferredDateTime"**: string } | Requesting Visa to process the request as a deferred OCT transaction. | No | | statusIdentifier | string | required when call times out | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Applicable only for Top Up Transactions | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### PushFundsTransactionGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response code
    Note: : The VisaNet Response Source for the transaction | Yes | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode
    *Example:* `"string"` | No | | prepaidBalance | string | Min Inclusive: -999999999.999
    Max Inclusive: 999999999.999
    Applicable only for Top Up Transactions | No | | settlementInfo | { **"settlementAmount"**: number (bigDecimal), **"settlementCurrencyCode"**: integer, **"settlementConversionRate"**: number (bigDecimal) } | Note:
    get the value in decimal values by combining rate value with rate decimal positions | No | | deferredOCTData | { **"requestType"**: string, **"deferredDateTime"**: string } | Requesting Visa to process the request as a deferred OCT transaction. | No | | statusIdentifier | string | required when call times out | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Applicable only for Top Up Transactions | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### GetAliasResponse-2 Schema Response data when a consumer alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | Conditional. This field will not be returned if the object 'aliases' presents.
    This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | No | | status | string | The status of an alias. For consumer alias, this value can be 'INACTIVE', 'ACTIVE', or 'DISABLED'. For merchant/agent alias, this value can be 'ACTIVE' or 'DISABLED'.
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | aliases | { **"alias"**: string, **"aliasType"**: string, **"isDefault"**: string } | | No | | country | string | Consumer’s country code as defined by ISO 3166. | Yes | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum | Yes | | aliasType | string | Conditional. This field will not be returned if the object 'aliases' presents.
    “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | No | | expiryDate | string | Card expiration date. | Yes | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Consumer’s postal code | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss.
    It is in Coordinated Universal Time (UTC). | No | | recipientLastName | string | Last name of the consumer. | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | Yes | | recipientMiddleName | string | Consumer’s middle name. | No | | statusChangeDateTime | string | The date and time when the status of an alias is changed. It is in Coordinated Universal Time (UTC).
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer’s card number | Yes | #### GetAliasResponse-3 Schema Response data when a consumer alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | Conditional. This field will not be returned if the object 'aliases' presents.
    This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | No | | status | string | The status of an alias. For consumer alias, this value can be 'INACTIVE', 'ACTIVE', or 'DISABLED'. For merchant/agent alias, this value can be 'ACTIVE' or 'DISABLED'.
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | aliases | { **"alias"**: string, **"aliasType"**: string, **"isDefault"**: string } | | No | | country | string | Consumer’s country code as defined by ISO 3166. | Yes | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum | Yes | | aliasType | string | Conditional. This field will not be returned if the object 'aliases' presents.
    “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | No | | expiryDate | string | Conditional. Card expiration date.
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Consumer’s postal code | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss.
    It is in Coordinated Universal Time (UTC). | No | | recipientLastName | string | Last name of the consumer. | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | Yes | | recipientMiddleName | string | Consumer’s middle name. | No | | statusChangeDateTime | string | The date and time when the status of an alias is changed. It is in Coordinated Universal Time (UTC).
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer’s card number | Yes | #### GetAliasResponse-4 Schema Response data when a consumer alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | Conditional. This field will not be returned if the object 'aliases' presents.
    This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | No | | status | string | The status of an alias. For consumer alias, this value can be 'INACTIVE', 'ACTIVE', or 'DISABLED'. For merchant/agent alias, this value can be 'ACTIVE' or 'DISABLED'.
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | aliases | { **"alias"**: string, **"aliasType"**: string, **"isDefault"**: string } | | No | | country | string | Consumer’s country code as defined by ISO 3166. | Yes | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Classic, Visa Platinum | Yes | | aliasType | string | Conditional. This field will not be returned if the object 'aliases' presents.
    “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | No | | expiryDate | string | Card expiration date. | Yes | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Consumer’s postal code | No | | contactEmail | string | Consumer’s contact email for all communications. | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal personal data for VAD service. Format: YYYY-MM-DD hh:nn:ss.
    It is in Coordinated Universal Time (UTC). | No | | recipientLastName | string | Last name of the consumer. | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for all communications. | No | | recipientFirstName | string | Consumer’s first name. | Yes | | recipientMiddleName | string | Consumer’s middle name. | No | | statusChangeDateTime | string | The date and time when the status of an alias is changed. It is in Coordinated Universal Time (UTC).
    Note: This attribute is only applicable to selective markets. Please contact Visa's representative for details. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer’s card number | Yes | #### AliasResolveRequest Schema Alias Resolve Request Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | alias | string | This attribute is used to retrieve recipient's Primary Account Number (PAN) of the card holder which can then be used in subsequent services such as Visa Direct.
    This attribute can contain information of a mobile phone number, email address, IBAN, merchant ID, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:
    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | | accountLookUp | string | Retrieve the attributes that determine the key characteristics of a recipient payment account before initiating a funds transfer by providing the Primary Account Number (PAN).
    If such attributes are required, set the value as 'Y'. Default is set as 'N' | No | | inviteSMSParameters | { **"amount"**: string, **"language"**: string, **"senderName"**: string } | Optional parameters to allow originator provide sender information to Visa for constructing notification message to be sent via SMS or other means to invite receiver registering their alias in the Alias Directory if the alias mapping cannot be found (i.e. HTTP Error 404 in RESOLVE API response). Note: This is only available in selected markets, please contact Visa's representative for details. | No | | businessApplicationId | string,
    **Available values:** "PP", "MP", "CO", "CI" | Used to identify program’s business application type for VisaNet transaction processing. It can be PP for Personal payment, MP for Merchant Payment, CO for Cash Out, CI for Cash In
    *Enum:* `"PP"`, `"MP"`, `"CO"`, `"CI"` | Yes | #### PushFundsTransactionGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | tokenData | { **"tokenAssuranceMethod"**: string } | First nine digits of the cardholder primary account number (PAN) or the full cardholder PAN, in case where a token is used in the transaction. | No | | actionCode | string | The results of the transaction request

    Refer to action code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | persistentFX | { **"exchangeRate"**: number (bigDecimal), **"visaRateTableId"**: string, **"visaRateProvider"**: string } | | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to response code
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999
    Max Inclusive: 999999999.999
    Applicable only for Top Up Transactions | No | | settlementInfo | { **"settlementAmount"**: number (bigDecimal), **"settlementCurrencyCode"**: integer, **"settlementConversionRate"**: number (bigDecimal) } | Note:
    get the value in decimal values by combining rate value with rate decimal positions | No | | deferredOCTData | { **"requestType"**: string, **"deferredDateTime"**: string } | Requesting Visa to process the request as a deferred OCT transaction. | No | | statusIdentifier | string | required when call times out | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | responseReasonCode | string | This field contains the merchant advice code value received from Mastercard authorization response messages. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | string | Applicable only for Top Up Transactions | No | | vauRTAuthReplacementData | { **"vauFlag"**: string, **"vauAccntStatus"**: string, **"replacementCardID"**: string, **"vauErrorReasonCode"**: string, **"replaceDateExpiration"**: string } | | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | #### GetMerchantAliasResponse Schema Response data when a merchant or agent alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Merchant or agent city. | Yes | | email | string | Merchant or agent email address. | No | | phone | string | Merchant or agent phone number. | No | | aliasId | string | This attribute is uniquely used by Acquirer to identify their merchant or agent . | Yes | | country | string | Merchant or agent country code as defined by ISO 3166. ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | Yes | | aliasType | string | 01 – Phone number
    02 – Email address
    03 – USSD Payment ID
    04 – BID (Bank Identification Number)
    05 – National ID
    06 – Custom
    Null – Should start with visa assigned USSD Payment ID | No | | merchantId | string | A 16 digit-number as per Mobile Push Payment Program Implementation Guide to receive payment by merchant or agent. | Yes | | postalCode | string | Merchant or agent postal code. | No | | recipientName | string | Merchant or agent name. | Yes | | convenienceFeeAmount | string | The convenience fee of a fixed amount. Applicable only for merchant alias. | No | | merchantCategoryCode | string | Merchant Category Code. Numeric only. | Yes | | payloadFormatIndicator | string | Defines the format of the merchant data payload. Payload Format Indicator must be set to '01' as per EMVCo Merchant Presented QR specifications. | Yes | | pointOfInitiationMethod | string | In this two-digit field, the first character indicates the method by which the data is presented by the merchant. The second character indicates whether the data is static or dynamic. Static data refers to a situation wherein same data is presented for every transaction unlike a dynamic data wherein the information is specific to a transaction.
    1st character
    '1' = QR
    '2' = BLE
    '3' = NFC
    '4' - '9' = Reserved for Future Use
    2nd character
    '1' = Static
    '2' = Dynamic
    '3' - '9' = Reserved for Future Use.
    Example: '11' indicates QR static code, '12' indicates QR dynamic code. | No | | transactionCurrencyCode | string | As defined by ISO 4217. This is the transaction currency code that a merchant can accept for payment. 3-digit numeric presentation of the currency is recommended to be used if alias may be used for QR. | Yes | | convenienceFeePercentage | string | Applicable only for merchant alias. The percentage convenience fee, specified as numeric value from “00.01” (for 00.01%) to “99.99” (for 99.99%). | No | | tipConvenienceFeeIndicator | string | Tip or Convenience Fee Indicator. This shall contains a value of '01', '02' or '03' as per EMVCo Merchant Presented QR specifications. Applicable only for merchant alias. | No | #### CardAcceptor-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | Name of the originator/money transfer operator. This is the same as cardAcceptor.name previously sent in the request for PullFunds, PushFunds or ReverseFunds transaction API calls. | No | | idCode | string | An identifier for the card acceptor (Visa Direct Originator). This is the same as cardAcceptor.idCode previously sent in the request for PullFunds, PushFunds or ReverseFunds transaction API calls. | No | #### CardAcceptorAddressmr Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Originator must populate this field with the city name of the Merchant. | No | | state | string | Use a 2-character abbreviated states code or territory code as the state value. Make sure to give a valid state code for given country. | No | | county | string | This is to be populated with the county of the Merchant. | No | | country | string | Originator must populate this field with the country code of the Merchant. Refer to [ISO Codes](https://developer.visa.com/guides/request_response_codes#isoCodes). | No | | zipCode | string | Zip/Postal code of the merchant. | No | #### MultiPushFundsTransactionGetResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to Action Code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Applicable only for Top Up Transactions | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | required when call times out | Yes | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | object | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | #### MultiPushFundsTransactionGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to Action Code
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | cvv2ResultCode | string | Results of the CVV2 validation for the primaryAccountNumber in the request. When dtvv is provided in cardCvv2Value in the request, cvv2ResultCode will be sent in response along with tokenVerificationResult
    Refer to cvv2ResultsCode
    *Example:* `"string"` | No | | prepaidBalance | string | Min Inclusive: -999999999.999

    Max Inclusive: 999999999.999

    Applicable only for Top Up Transactions | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | required when call times out | Yes | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | feeProgramIndicator | string | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52.000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | prepaidBalanceCurrency | object | | No | | enablerVerificationValue | binary | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and an Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format : ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year). hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | #### MerchantPushPaymentResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | Contains a code that defines the response to a request.
    Refer to actionCode | Yes | | approvalCode | string | Conditional. Contains the authorization code provided by the recipient when a transaction is approved. Visa recommends that recipients maintain uniqueness of this code for a given merchant PAN, however Visa would not maintain any checks for uniqueness. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"country"**: string } } | It is optional for recipient to send card acceptor field in the response. However, if it is in the response, all merchant name, city and country need to be there. | No | | responseCode | string | It is added by VisaNet and contains the response source/reason code that identifies the source of the actionCode response decision. | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | Required when API response times out. | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transaction. | No | | memberSuppliedIRF | string | Optional field which contains interchange fee provided by recipient and its only relevant for LAC regional markets. List of Countries supported:
    1. Costa Rica
    2. Dominican Republican
    3. Venezuela
    4. Guatemala | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | purchaseIdentifier | { **"type"**: string, **"referenceNumber"**: string } | | No | | feeProgramIndicator | string | Optional field which may be populated by recipient where applicable. | No | | merchantCategoryCode | string | Numeric only. Recipient should populate the MCC of the merchant in the response message. | No | | transmissionDateTime | dateTime | The value in response must match the value in the request. | Yes | | transactionIdentifier | string | It is added by VisaNet. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | reimbursementAttribute | string | This field contains a code that identifies the applicable interchange reimbursement fee for the transaction. Please contact your Regional Visa Client Support Services Representative to identify the value that you should be using. | No | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. Value will be the same as what has been provided in the request. | Yes | | argentinaReimbursementFee | double | Optional, this field contains the Argentina member supplied reimbursement fee. If present, populate 0 | No | | merchantVerificationValue | string | Recipient are expected to populate the Merchant Verification Value used to identify merchants that participate in a variety of programs in this field The valid values are 0-9 and A-F. These values are hexadecimal. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification, then this field to be populated for Argentina domestic transaction. | No | #### CancelDeferredPushFundsTransactionPostPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | acquiringBin | number | The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment. | Yes | | transactionIdentifier | number (int64) | The VisaNet reference number for the transaction. This is the same transactionIdentifier previously sent in the request for the original deferred OCT request. It is recommended to send transactionIdentifier while requesting cancellation. | No | | systemsTraceAuditNumber | number | A number assigned by the message initiator that uniquely identifies a transaction. This is the same as systemsTraceAuditNumber previously sent in the request for the original deferred OCT request. | Yes | | retrievalReferenceNumber | number | A value used to tie together service calls related to a single financial transaction. This is the same as retrievalReferenceNumber previously sent in the request for the original deferred OCT request. | Yes | #### AliasResponse-1 Schema Response if a recipient is successfully created,updated or deleted. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | GUID of the consumer of issuer is returned if alias is created/updated/deleted successfully. | No | #### MultiReverseFundsTransactionPostResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | Yes | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### MultiReverseFundsTransactionPostResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | networkId | integer | This contains a code that identifies the network on which the transaction was processed.

    Refer to Network ID

    Note:
    This field is returned only if it is anything other than networkId value 2.

    Supported only in US for domestic transactions. | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | statusIdentifier | string | | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | merchantVerificationValue | string | The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned. | No | #### AliasResponse-3 Schema Response if a recipient is successfully created,updated or deleted. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | GUID of the consumer of issuer is returned if alias is created/updated/deleted successfully. | No | #### MultiReverseFundsTransactionRequests Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The total amount to be sent to the recipient.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | networkId | integer | This contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

    Refer to Network ID

    Note:
    For ReverseFundsTransactions(AFTR) and MultiReverseFundsTransactions (MULTIAFTR) originators must populate the networkId returned in the original PullFundsTransactions(AFT) and MultiPullFundsTransactions (MULTIAFT) response.
    Supported only in US for domestic transactions. | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"motoECIIndicator"**: string, **"posConditionCode"**: integer } | | No | | senderCurrencyCode | string | Use a 3-character alpha currency code for currency of the sender.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: dateTime, **"systemsTraceAuditNumber"**: integer } | | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | transactionIdentifier | long | The VisaNet reference number for the transaction. You must use the transactionId from the initial AFT in this field. | Yes | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method where this is required. however, when passing the Account Funding Transaction Reversal (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | | Yes | | nationalReimbursementFee | double | When present, this field contains the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format: ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

    hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
    Note:
    If a currency has one decimal place, the last digit of this field must be zero.
    If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | senderPrimaryAccountNumber | string | The primary account number of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### AliasResponse-2 Schema Response if a recipient is successfully updated. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute represents the unique id for a payment instrument belonging to a consumer cardholder. | No | #### Track2Data Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | track2Data | binary | Conditional Note: For a CardPresent scenario, MagneticStripeData.track1Data (or MagneticStripeData.track2Data) must be included. | Yes | **Example** 
    4000340099900505=2225111123400001230
    #### AdjustFundsTransactionPostPayload-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The amount of the transaction, inclusive of all fees assessed for the transaction, including currency conversion fees. | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field needs to be populated for Argentina domestic (Debit) transactions when businessApplicationId has PS. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic (Credit) transaction when businessApplicationId has PS. | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. This code identifies the currency of the transaction amount sent in the amount field. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct program is registered. | Yes | | merchantCategoryCode | integer | Contains a code describing the merchant's type of business product or service, also known as the merchant category code (MCC). These codes are based on the Merchant Classification Code Guideline available from the Bank Card Division of the ABA. Clients should send the same merchantCategoryCode that was submitted in the PullFundsTransactions | Yes | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber. | No | | businessApplicationId | string | Identifies the Visa Direct use case required for processing. This must match the value provided in the request of PullFundsTransactions. | Yes | | transactionIdentifier | long | Clients should send the Visa transaction identifier returned in the response of PullFundsTransactions. | Yes | | systemsTraceAuditNumber | integer | This field contains a number assigned by the merchant, service provider or acquirer that uniquely identifies a cardholder transaction and all message types (also known as system transactions) that comprise it per individual program rules. A unique value should be used for each API invocation. | Yes | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer. | Yes | | retrievalReferenceNumber | string | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Recommended format: ydddhhnnnnnn. The first four digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year), hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed, nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. A unique value should be used for each API invocation. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
    Note:
    If a currency has one decimal place, the last digit of this field must be zero.
    If a currency has no decimal place, the last two digits of this field must be zero. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | senderPrimaryAccountNumber | string | This field contains a number identifying the customer account which could be a PAN or a token. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | senderIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic (Credit) transaction when businessApplicationId has PS. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field needs to be populated for Argentina domestic (Debit) transactions when businessApplicationId has PS. | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Please reach out to your Visa representative for details. | No | #### AdjustFundsTransactionPostResponse-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"senderReference"**: string, **"customerReference"**: string, **"merchantReference"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string, **"senderIdentificationNumberBusiness"**: string, **"senderIdentificationNumberIndividual"**: string } | | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | transactionIdentifier | long | Visa transaction identifier . | Yes | | dateAndTimeTransmission | dateTime | This field contains the year, month, day, and time the transaction was processed by Visa Direct. Example: 2016-01-15T07:03:52.000Z | Yes | | cpsAuthorizationCharacteristicsIndicator | string | ConditionalIndicates whether AFT transaction has qualified for CPS. Possible values are : whatever was sent in the request will be sent back in this response field.
    Note:Supported only in US for CPS (Custom Payment Service). Please reach out to your Visa representative for details. | No | #### AdjustFundsTransactionPostResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"senderReference"**: string, **"customerReference"**: string, **"merchantReference"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string, **"senderIdentificationNumberBusiness"**: string, **"senderIdentificationNumberIndividual"**: string } | | No | | customerReference | string | This field contains a value that identifies the customer.
    This field will be populated in the response for Argentina domestic AFT Credit Adjustment, transactions when businessApplicationId is "PS". | No | | merchantReference | string | This field contains the merchant account key value for Argentina domestic purchase (POS) transactions.
    This field will be populated in the response for Argentina domestic, OCT Debit Adjustment, transactions where businessApplicationId is "PS". | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | Visa transaction identifier . | Yes | | dateAndTimeTransmission | dateTime | This field contains the year, month, day, and time the transaction was processed by Visa Direct. Example: 2016-01-15T07:03:52.000Z | Yes | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification.
    This field will be populated in the response for Argentina domestic AFT Credit Adjustment, transactions when businessApplicationId is "PS". | No | | recipientIdentificationNumberBusiness | string | For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN).
    This field will be populated in the response for Argentina domestic OCT Debit Adjustment, transactions where businessApplicationId is "PS". | No | | cpsAuthorizationCharacteristicsIndicator | string | ConditionalIndicates whether AFT transaction has qualified for CPS. Possible values are : whatever was sent in the request will be sent back in this response field.
    Note:Supported only in US for CPS (Custom Payment Service). Please reach out to your Visa representative for details. | No | #### AdjustFundsTransactionPostPayload-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The amount of the transaction, inclusive of all fees assessed for the transaction, including currency conversion fees.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string, **"paymentFacilitator"**: { **"additionalAcceptor"**: { **"foreignRetailerIndicator"**: string,
    **Available values:** "A", "B" } } } | | Yes | | cardExpiryDate | string |
    Recommended Format: YYYY-MM
    The expiration date for the sender's Visa account number in primaryAccountNumber. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | schemeIdentifier | string | Defines the card scheme selected of a co-badged cards for the transaction.Only 2 values supported.
    01-Visa
    02-Other
    The values will expand in future. | No | | customerReference | string | Conditional.

    This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | merchantReference | string | Conditional.

    This field contains the merchant account key value for Argentina domestic purchase (POS) transactions.
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. This code identifies the currency of the transaction amount sent in the amount field.
    This field will be deprecated. Please use the replacement field transactionCurrencyCode instead. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct program is registered. | Yes | | merchantCategoryCode | integer | Contains a code describing the merchant's type of business product or service, also known as the merchant category code (MCC). These codes are based on the Merchant Classification Code Guideline available from the Bank Card Division of the ABA. Clients should send the same merchantCategoryCode that was submitted in the PullFundsTransactions | Yes | | primaryAccountNumber | string | Conditional

    This field contains a number identifying the customer account which could be a PAN or a token. | No | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber.
    This field will be deprecated. Please use the replacement field cardExpiryDate instead. | No | | businessApplicationId | string | Identifies the Visa Direct use case required for processing. This must match the value provided in the request of PullFundsTransactions.
    For Argentina domestic purchase transactions the value should be "PS". | Yes | | serviceProcessingType | { **"requestType"**: string } | Optional.

    This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | Clients should send the Visa transaction identifier returned in the response of PullFundsTransactions. | Yes | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | systemsTraceAuditNumber | integer | This field contains a number assigned by the merchant, service provider or acquirer that uniquely identifies a cardholder transaction and all message types (also known as system transactions) that comprise it per individual program rules. A unique value should be used for each API invocation. | Yes | | transactionCurrencyCode | string | Conditional

    Use a 3-character alpha or numeric currency code for currency of the transaction. This code identifies the currency of the transaction amount sent in the amount field. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer. | Yes | | retrievalReferenceNumber | string | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Recommended format: ydddhhnnnnnn. The first four digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year), hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed, nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. A unique value should be used for each API invocation. | Yes | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderPrimaryAccountNumber | string | This field contains a number identifying the customer account which could be a PAN or a token.
    This field will be deprecated. Please use the replacement field primaryAccountNumber instead. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | senderIdentificationNumberIndividual | string | Conditional.

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | recipientIdentificationNumberBusiness | string | Conditional.

    For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN).
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Please reach out to your Visa representative for details. | No | #### CardAcceptorAddressmrr Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Originator must populate this field with the city name of the Merchant. | No | | state | string | Use a 2-character abbreviated states code or territory code as the state value. Make sure to give a valid state code for given country. | No | | county | string | This is to be populated with the county of the Merchant. | No | | country | string | Originator must populate this field with the country code of the Merchant. Refer to [ISO Codes](https://developer.visa.com/guides/request_response_codes#isoCodes). | No | | zipCode | string | Zip/Postal code of the merchant. | No | #### AdjustFundsTransactionPostResponse-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode | Yes | | settlementFlags | { **"givUpdatedFlag"**: string, **"senderReference"**: string, **"customerReference"**: string, **"merchantReference"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string, **"senderIdentificationNumberBusiness"**: string, **"senderIdentificationNumberIndividual"**: string } | | No | | customerReference | string | This field contains a value that identifies the customer.
    This field will be populated in the response for Argentina domestic AFT Credit Adjustment, transactions when businessApplicationId is "PS". | No | | merchantReference | string | This field contains the merchant account key value for Argentina domestic purchase (POS) transactions.
    This field will be populated in the response for Argentina domestic, OCT Debit Adjustment, transactions where businessApplicationId is "PS". | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | serviceProcessingType | { **"requestType"**: string } | This field will contain values that identifies the type of service assigned for the transaction. | No | | transactionIdentifier | long | Visa transaction identifier . | Yes | | dateAndTimeTransmission | dateTime | This field contains the year, month, day, and time the transaction was processed by Visa Direct. Example: 2016-01-15T07:03:52.000Z | Yes | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderIdentificationNumberIndividual | string | This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification.
    This field will be populated in the response for Argentina domestic AFT Credit Adjustment, transactions when businessApplicationId is "PS". | No | | recipientIdentificationNumberBusiness | string | For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN).
    This field will be populated in the response for Argentina domestic OCT Debit Adjustment, transactions where businessApplicationId is "PS". | No | | cpsAuthorizationCharacteristicsIndicator | string | ConditionalIndicates whether AFT transaction has qualified for CPS. Possible values are : whatever was sent in the request will be sent back in this response field.
    Note:Supported only in US for CPS (Custom Payment Service). Please reach out to your Visa representative for details. | No | #### AdjustFundsTransactionPostPayload-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The amount of the transaction, inclusive of all fees assessed for the transaction, including currency conversion fees.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | cardExpiryDate | string |
    Recommended Format: YYYY-MM
    The expiration date for the sender's Visa account number in primaryAccountNumber. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | customerReference | string | Conditional.

    This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | merchantReference | string | Conditional.

    This field contains the merchant account key value for Argentina domestic purchase (POS) transactions.
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. This code identifies the currency of the transaction amount sent in the amount field.
    This field will be deprecated. Please use the replacement field transactionCurrencyCode instead. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct program is registered. | Yes | | merchantCategoryCode | integer | Contains a code describing the merchant's type of business product or service, also known as the merchant category code (MCC). These codes are based on the Merchant Classification Code Guideline available from the Bank Card Division of the ABA. Clients should send the same merchantCategoryCode that was submitted in the PullFundsTransactions | Yes | | primaryAccountNumber | string | Conditional

    This field contains a number identifying the customer account which could be a PAN or a token. | No | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber.
    This field will be deprecated. Please use the replacement field cardExpiryDate instead. | No | | businessApplicationId | string | Identifies the Visa Direct use case required for processing. This must match the value provided in the request of PullFundsTransactions.
    For Argentina domestic purchase transactions the value should be "PS". | Yes | | serviceProcessingType | { **"requestType"**: string } | Optional.

    This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | Clients should send the Visa transaction identifier returned in the response of PullFundsTransactions. | Yes | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | systemsTraceAuditNumber | integer | This field contains a number assigned by the merchant, service provider or acquirer that uniquely identifies a cardholder transaction and all message types (also known as system transactions) that comprise it per individual program rules. A unique value should be used for each API invocation. | Yes | | transactionCurrencyCode | string | Conditional

    Use a 3-character alpha or numeric currency code for currency of the transaction. This code identifies the currency of the transaction amount sent in the amount field. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer. | Yes | | retrievalReferenceNumber | string | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Recommended format: ydddhhnnnnnn. The first four digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year), hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed, nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. A unique value should be used for each API invocation. | Yes | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderPrimaryAccountNumber | string | This field contains a number identifying the customer account which could be a PAN or a token.
    This field will be deprecated. Please use the replacement field primaryAccountNumber instead. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | senderIdentificationNumberIndividual | string | Conditional.

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | recipientIdentificationNumberBusiness | string | Conditional.

    For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN).
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Please reach out to your Visa representative for details. | No | #### AliasResponse-4 Schema Response if an alias mapping is successfully created. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute represents the unique id for a payment instrument belonging to a consumer cardholder. | No | #### AdjustFundsTransactionPostPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | double | The amount of the transaction, inclusive of all fees assessed for the transaction, including currency conversion fees.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | | Yes | | cardExpiryDate | string |
    Recommended Format: YYYY-MM
    The expiration date for the sender's Visa account number in primaryAccountNumber. | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | customerReference | string | Conditional.

    This field contains a value that identifies the customer.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | merchantReference | string | Conditional.

    This field contains the merchant account key value for Argentina domestic purchase (POS) transactions.
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender. This code identifies the currency of the transaction amount sent in the amount field.
    This field will be deprecated. Please use the replacement field transactionCurrencyCode instead. | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct program is registered. | Yes | | merchantCategoryCode | integer | Contains a code describing the merchant's type of business product or service, also known as the merchant category code (MCC). These codes are based on the Merchant Classification Code Guideline available from the Bank Card Division of the ABA. Clients should send the same merchantCategoryCode that was submitted in the PullFundsTransactions | Yes | | primaryAccountNumber | string | Conditional

    This field contains a number identifying the customer account which could be a PAN or a token. | No | | senderCardExpiryDate | string | The expiration date for the sender's Visa account number in senderPrimaryAccountNumber.
    This field will be deprecated. Please use the replacement field cardExpiryDate instead. | No | | businessApplicationId | string | Identifies the Visa Direct use case required for processing. This must match the value provided in the request of PullFundsTransactions.
    For Argentina domestic purchase transactions the value should be "PS". | Yes | | serviceProcessingType | { **"requestType"**: string } | Optional.

    This field will contain values that identify the type of service the transaction should be processed. | No | | transactionIdentifier | long | Clients should send the Visa transaction identifier returned in the response of PullFundsTransactions. | Yes | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | systemsTraceAuditNumber | integer | This field contains a number assigned by the merchant, service provider or acquirer that uniquely identifies a cardholder transaction and all message types (also known as system transactions) that comprise it per individual program rules. A unique value should be used for each API invocation. | Yes | | transactionCurrencyCode | string | Conditional

    Use a 3-character alpha or numeric currency code for currency of the transaction. This code identifies the currency of the transaction amount sent in the amount field. | No | | localTransactionDateTime | dateTime | This field contains the local date and time when the transaction is submitted by a merchant, service provider or acquirer. | Yes | | retrievalReferenceNumber | string | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Recommended format: ydddhhnnnnnn. The first four digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year), hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed, nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. A unique value should be used for each API invocation. | Yes | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | senderPrimaryAccountNumber | string | This field contains a number identifying the customer account which could be a PAN or a token.
    This field will be deprecated. Please use the replacement field primaryAccountNumber instead. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | senderIdentificationNumberIndividual | string | Conditional.

    This field contains the identification number issued to the individual by the government or an authorized national entity. For Argentina domestic purchase transactions this field contains the customer’s VAT registration number for tax identification.
    This field needs to be populated for Argentina domestic (OCT Debit Adjustment ) transactions where businessApplicationId is "PS". | No | | recipientIdentificationNumberBusiness | string | Conditional.

    For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN).
    This field needs to be populated for Argentina domestic (AFT Credit Adjustment ) transactions where businessApplicationId is "PS". | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation).

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Please reach out to your Visa representative for details. | No | #### MultiReverseFundsTransactionGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | The results of the transaction request

    Refer to actionCode
    Note: : The VisaNet Response Code for the transaction | Yes | | last4ofPAN | integer | This field contains the last four digits of the cardholder primary account number (PAN) | No | | approvalCode | string | The authorization code from the issuer. | No | | responseCode | string | The source for the response; typically, either the recipient issuer or a Visa system.

    Refer to responseCode
    Note: : The VisaNet Response Source for the transaction | Yes | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | settlementFlags | { **"givUpdatedFlag"**: string, **"settlementServiceFlag"**: string, **"givPreviouslyUpdatedFlag"**: string, **"settlementResponsibilityFlag"**: string } | | No | | statusIdentifier | string | | Yes | | customerReference | string | This is an alphanumeric value that carries the value that identifies the customer, the value may be a reference number or code or generic number. This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | | feeProgramIndicator | object | | No | | transmissionDateTime | dateTime | Example: 2016-01-15T07:03:52:000Z | Yes | | transactionIdentifier | long | The VisaNet reference number for the transaction

    Note:
    transactionIdentifier is a Visa generated field that client recieves in the response message.
    Note: As an exception Visa allows clients to use the transactionIdentifier received in the AFT response into the subsequent OCT message - this is to simplify matching the pull and push transaction pair and reconciliation. | Yes | | enablerVerificationValue | binary | This field is to allow the application of the interchange discount at the enabler level. | No | | senderIdentificationNumberIndividual | string | This is an alphanumeric value that contains the customer’s VAT registration number for the individual tax identification.
    This field is to be populated if the recipient is an Individual (e.g. P2P payments). This field to be populated for Argentina domestic transactions when businessApplicationId has PS. | No | #### PaymentAccountAttributesInquiry-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | issuerName | string | Issuer name of the consumer card. | Yes | | cardTypeCode | string | The code of account funding source for the card, e.g. Credit, Debit, Prepaid, Charge, Deferred Debit.
    Refer to cardTypeCode | No | | geoRestrictionInd | string | This field will determine if the recipient issuer can accept transactions from the Originator country. If the value is 'Y', transactions cannot be accepted from the sender country. If the value is 'N', transactions are allowed. | Yes | | fastFundsIndicator | string | Indicates the funds delivery speed of the PAN submitted in the request. If the value is 'B', 'C', or 'D', funds will be available to the recipient within 30 minutes of successful transfer. If the value is 'N', the funds will be available within 2 business days of successful transfer.
    Refer to fastFundsIndicator | Yes | | billingCurrencyCode | integer | Use a 3-digit numeric currency code for the card billing currency of the PAN.
    Refer to ISO Codes | Yes | | cardIssuerCountryCode | string | Refer to ISO Codes | Yes | | pushFundsBlockIndicator | string | Indicates whether the PAN submitted in the request can receive Push Funds(OCTs).
    Refer to pushFundsBlockIndicator | Yes | | onlineGambingBlockIndicator | string | Indicates whether the PAN submitted in the request can receive Push Funds(OCTs) for gambling-type transactions. If the value is 'Y', then the account cannot receive gambling Push Funds (OCTs). If the value is 'N', the account can receive gambling Push Funds (OCTs). | Yes | | billingCurrencyCodeMinorDigits | string | Identifies the number of decimal positions that should be present in any amounts for the requested card's billing currency. | No | #### DeleteAliasRequest Schema Request payload data for deleting an alias.

    Note. This API allows issuer to delete only one mapping of an alias to an account at one time. To delete
    • the mappings of multiple aliases linked to the same PAN; and/or
    • the mappings of one alias linked to multiple accounts
    issuer is required to submit multiple API requests. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | guid | string | This attribute is uniquely used by issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:

    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | #### MerchandiseReturnReversalTransactionPayload Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | amount | string | The amount must match the original refund transaction. | Yes | | acquiringBin | string | This BIN number identifies the originator of refund transaction. This information must match the BIN provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string } | This must be the same value as in the original response. | Yes | | transactionFeeAmt | string | Prefix ‘D’Originators are required to populate convenience fee amount in this field to be returned, if presented in the original refund message. | No | | senderCurrencyCode | string | The code in this field must always reflect the currency previously sent in the original refund transaction. | Yes | | acquirerCountryCode | string | Use a 3-digit numeric country code for the country. This must match the information provided during program enrollment. | Yes | | feeProgramIndicator | string | Originators can leave this field blank. | No | | originalDataElements | { **"acquiringBin"**: integer, **"approvalCode"**: string, **"transmissionDateTime"**: string, **"systemsTraceAuditNumber"**: integer } | | Yes | | transactionIdentifier | string | Conditional. If originator submits merchant payment transaction using MerchantPushPayments API, they should submit the same value of transactionIdentifier in API request. Otherwise, do not use this field in the API request. | Yes | | systemsTraceAuditNumber | string | Numeric only. This value must match with the systemsTraceAuditNumber previously sent in the original refund transaction. | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | This should be +/- 3 days from the current date.

    The date is in yyyy-mm-ddThh:mm:ss format | Yes | | retrievalReferenceNumber | string | Numeric only. This value must match the retrievalReferenceNumber previously sent in the original refund transaction. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | recipientPrimaryAccountNumber | string | Populate with Consumer PAN used in the refund transaction. | Yes | #### GetReportResponse-2 Schema Response data when a merchant or agent alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | _links | { **"last"**: string, **"next"**: string, **"self"**: string, **"first"**: string, **"previous"**: string } | This contains the navigation url links of the report, i.e. 'self', 'first', 'next'(if applicable),'previous'(if applicable),'last'(if applicable). | Yes | | content | { **"guid"**: string, **"status"**: string, **"aliasId"**: string, **"merchantId"**: string, **"statusChangeDateTime"**: string } | Depending on the selected type of alias reports, this contains a list of consumer, merchant or agent alias records. | Yes | #### CardAcceptorAddress Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Originator must populate this field with value captured from merchant information display. If manual entered transaction then populate default value of 'mVisa payment'. | Yes | | country | string | Must include the 2-character alpha country code of the merchant captured from the merchant information display | Yes | #### PullFundsTransactionPostPayload-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | cavv | string | The Cardholder Authentication Verification Value (CAVV) is a value generated by an Access Control Server (ACS) and signed by the Issuer using account and password information of cardholders registered for the Verified by Visa (also known as Visa Secure) program. This field should be in hexabinary format. | No | | tavv | string | The Token Authentication Verification Value (TAVV) is a value generated using tokenized PAN by Visa Token Service (VTS) and signed by the Issuer. This field should be in hexabinary format.

    Note: A token should be send (instead of a PAN) in senderPrimaryAccountNumber field while sending a TAVV cryptogram. | No | | amount | double | The amount of the transaction, inclusive of all fees you assess for the transaction, including currency conversion fees. If the originator is populating the surcharge or foreignExchangeFeeTransaction field, they must be included in the amount field.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | pinData | { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | When present, this field contains sender's city | No | | senderName | string | Conditional.

    The Sender Name can be up to 30 characters long and must be the sender's legal name. If the sender's name is greater than thirty (30) characters, use only the first 30 characters of the name.
    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use senderFirstName, senderLastName & senderMiddleName instead.

    If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name.

    Recommended Format: Last Name/Family Surname 1 plus space \| Last Name/Family Surname 2(optional) plus space \| First Name plus space \| Middle Initial or Middle Name(optional)
    Note:

    - This field must not contain a ? (Question mark) or any special characters
    - Only a valid and legal recipient name must be populated in this field

    Example: Doe John A | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"taxID"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string, **"addressLine"**: string }, **"terminalId"**: string, **"urlAddress"**: string, **"partnerIDCode"**: string, **"legalBusinessName"**: string, **"contactInformation"**: { **"phoneNumber"**: string, **"additionalContactDetails"**: string, **"customerServicePhoneNumber"**: string }, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"country"**: string, **"postalCode"**: string, **"streetAddress"**: string }, **"subMerchantId"**: string, **"additionalAcceptor"**: { **"ids"**: [ { **"idType"**: string,
    **Available values:** "Marketplace", "Gateways", "StagedDigitalWallet", "RampProvider", **"idValue"**: string } ], **"foreignRetailerIndicator"**: string,
    **Available values:** "A", "B" }, **"independentSalesOrganizationID"**: string }, **"serviceLocationDetails"**: { **"address"**: { **"city"**: string, **"state"**: string, **"postalCode"**: string, **"countryCode"**: string } } } | | Yes | | chipCardData | string | A blob containing the Chip card data in TLV format
    *Example:* `"8201495F2A0201245F34010182021C008407A0000000031010950580000000009A031102249B0268009C01009F02060000000000009F03060000000000009F0607A00000000310109F0802008C9F0902008C9F100706010A039000009F1A0201249F2608423158936ED6C38F9F2701809F3303E0B0C89F34034103029F3501229F360200019F3704ACAC66E89F5800DF0100DF0200DF0400"` | No | | cardCvv2Value | string | The cardCvv2Value value provided by the account holder for the senderPrimaryAccountNumber in the request. | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientName | string | Conditional.

    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use recipientFirstName, recipientLastName & recipientMiddleName instead.

    This field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | senderAddress | string | When present, this field contains sender's Address

    Note:
    This field is not applicable for domestic Colombia transactions | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | recipientState | string | Required if RecipientCountryCode is either 124(CAN) or 840(USA)

    Note:
    This field is not applicable for domestic Colombia transactions | No | | senderLastName | string | Conditional

    This field contains sender's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderFirstName | string | Conditional

    This field contains sender's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

    Required if senderCountryCode is either 124(CAN) or 840(USA)

    Note:
    This field not applicable for domestic Colombia transactions | No | | purposeOfPayment | string | Conditional.

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market.
    For India, Bangladesh, Egypt, Saudi Arabia and Argentina-Purpose of payment is mandatory for all BAIs except CO,CI and MP
    For Chile-Purpose of payment is mandatory for BAI-FD
    For Colombia-Purpose of payment is mandatory for BAI-AA and PP | No | | schemeIdentifier | string | Defines the card scheme selected of a co-badged cards for the transaction.Only 2 values supported.
    01-Visa
    02-Other
    The values will expand in future. | No | | senderEntityType | string | Optional.

    This field identifies if the sender is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderMiddleName | string | This field contains sender's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | senderOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | senderPostalCode | string | When present, this field contains the sender's postal code

    Note: For domestic Colombia transactions, the maximum length of this field is 16 characters. For other transactions, the entered value should be between 5 and 10 characters. | No | | senderStreetName | string | Optional.

    This field contains the street name of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | Conditional.

    This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is "PS". | No | | messageReasonCode | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated.
    Note: Message reason code and POS Environment fields are mutually exclusive.

    Refer to Meassage Reason Codes | No | | recipientLastName | string | Conditional

    This field contains recipient's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderCountryCode | string | when present, this field contains sender's country code

    Refer to ISO Codes | No | | senderDateOfBirth | date | Account Owner Date of Birth.(format YYYY-MM-DD) | No | | senderNationality | string | ISO country code of nationality in alphabets. | No | | sourceOfFundsCode | string | when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.

    Refer to sourceOfFundsCode codes | No | | cardSequenceNumber | integer | Card Sequence Number
    *Example:* `1` | No | | magneticStripeData | { **"track1Data"**: string, **"track2Data"**: string } | | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
    Note: For a CardPresent Transactions, this field is required. | Yes | | recipientFirstName | string | Conditional

    This field contains recipient's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | riskAssessmentData | { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"scaEnvironmentOutageIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | | No | | senderAddressLine1 | string | Optional.

    This field contains the first line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderAddressLine2 | string | Optional.

    This field contains the second line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCurrencyCode | string |
    • Use a 3-character alpha or numeric currency code for currency of the sender.
    • For Cross-border, originator can use this field for its chosen currency or the sender's card currency (refer to the billingCurrency obtained from the Funds Transfer Attribute Inquiry API)*.
    Adjust amount accordingly based on chosen senderCurrencyCode.
    *Note: This currency may not always be the local currency code of the recipient.

    Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | masterCardUCAFField | string | This field contains Mastercard e-commerce Universal Cardholder Authentication data in encrypted form. It may also contain Mastercard telephone order data. | No | | recipientEntityType | string | Optional.

    This field identifies if the recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | recipientMiddleName | string | This field contains recipient's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | recipientOccupation | string | Account Owner Occupation. Only alpha-numeric data is accepted | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientStreetName | string | This field contains the street name of the recipient address.

    Maps to the following ISO 8583 field
    - Field 56, Tag 88 | No | | senderAccountNumber | string | When present, this field contains the sender's account number. This field is mandatory in XB AFTs it will contain the destination account number being funded with the AFT (e.g. IBAN number for loading a bank account, proprietary wallet number for loading a wallet, prepaid PAN number for loading a card, money transfer operator proprietary account number with acquirer for funding a money transfer). | No | | senderLocalNameData | { **"lastName"**: string, **"aliasName"**: string, **"firstName"**: string, **"middleName"**: string, **"languageCode"**: string, **"dataEncodingFormat"**: string } | This object is used to provide the sender's local name data. This object is required for transactions where the sender's local name data is required. | No | | senderMiddleInitial | string | This field contains sender's middle initial

    Note:
    This field is not applicable for domestic Colombia transactions | No | | merchantCategoryCode | integer | Note:     If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned). | Yes | | recipientCountryCode | string | when present, this field contains recipient's country code

    Refer to ISO Codes | No | | recipientDateOfBirth | date | Account Owner Date of Birth.(format YYYY-MM-DD) | No | | recipientNationality | string | ISO country code of nationality in alphabets. | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"ancillarySenderDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ] } | | No | | senderBuildingNumber | string | Optional.

    This field contains the house or the building number of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCardExpiryDate | date | This field contains the expiration date for the sender's Visa account number or token in senderPrimaryAccountNumber
    Format: YYYY-MM
    Example: 2021-10 | No | | senderCountryOfBirth | string | ISO country code of birth in alphabets | No | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Argentina domestic purchase transactions the value should be "PS".

    Refer to businessApplicationId codes | Yes | | originalTransactionId | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated

    Note: Merchants must link the Merchant-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring, installment, and unscheduled COF), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions. | No | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are destined to Australia and New Zealand or originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string } | Optional.

    This field will contain values that identify the type of service the transaction should be processed. | No | | recipientLocalNameData | { **"lastName"**: string, **"aliasName"**: string, **"firstName"**: string, **"middleName"**: string, **"languageCode"**: string, **"dataEncodingFormat"**: string } | This object is used to provide the recipient's local name data. This object is required for transactions where the recipient's local name data is required. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial

    Note:
    This field is not applicable for domestic Colombia transactions | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | addressVerificationData | { **"street"**: string, **"postalCode"**: string } | Conditional
    Address verification is required for an AFT transaction to qualify for CPS. Either send the card’s postal code or full address.

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Either the postalCode or full address of the card is required.

    Please reach out to your Visa representative for details. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantVolumeIndicator | integer | Merchant Volume Indicator to identify Nano/micro merchants (Peru market) Values: "51" (Micromerchant), "52" (Nanomerchant). | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ], **"ancillaryRecipientDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | recipientCountryOfBirth | string | ISO country code of birth in alphabets | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | additionalPOSInformation | { **"chipConditionCode"**: integer, **"chipTransactionIndicator"**: integer, **"chipAuthenticationReliabilityIndicator"**: integer } | | No | | enablerVerificationValue | binary | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | localTransactionDateTime | dateTime | This field contains the local date and time of the transaction takes place originated from merchant, service provider or acquirer.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | If present, this field should contain the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer, **"acceptsPartialAuthorizations"**: string,
    **Available values:** "TRUE", "FALSE" } | Note: This object and the nested fields are required for CardPresent Transaction and Partial Authorizations transactions. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format: ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

    hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | mastercardWalletIdentifier | string | This field contains the Wallet Program Data generated by the PayPass Online platform or MasterPass platform. | No | | optionalResponseParameters | string | Originators may choose to specify any or all of the following optional parameters to receive as part of the API response.

    E.g. Originators may specify comma-separated, optional parameters such as optionalResponseParameters (motoECIIndicator), if they want to receive motoECIIndicator in the API response.

    motoECIIndicator: Identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet) or the type of mail or telephone order. Acquirers supply indicator values, which V.I.P. forwards in requests and advices to issuers that have successfully tested to receive them. The subfield is dropped if issuers have not successfully completed testing or choose not to receive it.

    Refer to Moto ECI Codes

    E.g. optionalResponseParameters (motoECIIndicator) | No | | senderPersonalEmailAddress | string | Account owner email address. | No | | senderPrimaryAccountNumber | string | This is a 16-digit PAN or token of the sender's account. | No | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | mastercardAuthenticationData | string | The first character contains Mastercard 3DS Program Protocol for 3DS. Please refer to the Mastercard specification for a list of valid values.
    Next 36 characters contain the directory server transaction ID data.
    *Example:* `"1f38e6948-5388-41a6-bca4-b49723c19437"` | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator). Values in this field must be in the same currency and format as defined in the amount field. | No | | recipientPersonalEmailAddress | string | Account owner email address. | No | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | remoteCommerceAcceptorIdentifier | string | This field contains a merchant identifier encoded as Base64. For example website URL or reverse domain name. | No | | senderPaymentCredentialReference | { **"type"**: string,
    **Available values:** "PCI_TOKEN_REFID", "PAYMENT_CREDENTIAL_ID", **"value"**: string, **"merchantId"**: string } | Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID Conditional Only one of 'senderPrimaryAccountNumber' and 'senderPaymentCredentialReference' is provided in a request | No | | masterCardUCAFCollectionIndicator | string | E-commerce indicator that Mastercard Universal Cardholder Authentication data is included in the message. | No | | masterCardMerchantPaymentGatewayId | string | This field contains merchant payment gateway ID assigned by Mastercard, provided by the acquirer when a registered merchant payment gateway service provider participates in the transaction. Value is right-justified and zero-filled. | No | | recipientAccountIdentificationData | { **"recipientAccountIdentifierValue"**: string, **"recipientAccountIdentifierTypeCode"**: string } | | No | | recipientIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)

    If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    BB
    BI
    BP
    FT
    PP
    TU
    WT

    For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN). | No | | recipientIdentificationNumberIndividual | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is an Individual (e.g. P2P payments)

    If recipientIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    BB
    BI
    BP
    FT
    PP
    TU
    WT

    | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation)

    Note: Supported only in US for CPS (Custom Payment Service).

    This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.

    Please reach out to your Visa representative for details. | No | | digitalSecureRemotePaymentTokenCryptogram | string | This field contains Mastercard digital payment/Cryptogram data associated with the token. | No | #### PullFundsTransactionPostPayload-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | cavv | string | The Cardholder Authentication Verification Value (CAVV) is a value generated by an Access Control Server (ACS) and signed by the Issuer using account and password information of cardholders registered for the Verified by Visa (also known as Visa Secure) program. This field should be in hexabinary format. | No | | tavv | string | The Token Authentication Verification Value (TAVV) is a value generated using tokenized PAN by Visa Token Service (VTS) and signed by the Issuer. This field should be in hexabinary format.

    Note: A token should be send (instead of a PAN) in senderPrimaryAccountNumber field while sending a TAVV cryptogram. | No | | amount | double | The amount of the transaction, inclusive of all fees you assess for the transaction, including currency conversion fees. If the originator is populating the surcharge or foreignExchangeFeeTransaction field, they must be included in the amount field. | Yes | | pinData | { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | When present, this field contains sender's city | No | | senderName | string | Conditional.

    If the transaction is a money transfer and cross-border or U.S. domestic, this field must contain the sender's name.

    If the transaction is a funds disbursement and cross-border or U.S. domestic, this field must contain either the name of the merchant or government entity sending the funds disbursement.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, this field must contain the sender's name.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"idCode"**: string, **"address"**: { **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string }, **"terminalId"**: string, **"legalBusinessName"**: string, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"subMerchantId"**: string } } | | Yes | | cardCvv2Value | string | The cardCvv2Value value provided by the account holder for the senderPrimaryAccountNumber in the request. | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientName | string | Conditional.

    Recipient name is required for cross-border enhanced money transfer AFTs. | No | | senderAddress | string | When present, this field contains sender's Address | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | recipientState | string | Required if RecipientCountryCode is either 124(CAN) or 840(USA) | No | | senderLastName | string | This field contains sender's last name | No | | senderFirstName | string | This field contains sender's first name | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | When present, this field contains sender's state code | No | | purposeOfPayment | string | Conditional.

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market. | No | | senderMiddleName | string | This field contains sender's middle name | No | | senderPostalCode | string | When present, this field contains the sender's postal code | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | merchantReference | string | This is an alphanumeric value that carries the merchant’s unique identification number issued by the government or an authorized national entity. This field to be populated for Argentina domestic transaction when businessApplicationId has PS. | No | | messageReasonCode | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated.
    Note: Message reason code and POS Environment fields are mutually exclusive.

    Refer to Meassage Reason Codes | No | | recipientLastName | string | When present, this field contains recipient's last name | No | | senderCountryCode | string | when present, this field contains sender's country code

    Refer to ISO Codes | No | | sourceOfFundsCode | string | when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.

    Refer to sourceOfFundsCode codes | No | | magneticStripeData | { **"track1Data"**: string, **"track2Data"**: string } | | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
    Note: For a CardPresent Transactions, this field is required. | Yes | | recipientFirstName | string | When present, this field contains recipient's first name | No | | riskAssessmentData | { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

    Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientMiddleName | string | This field contains recipient's middle name | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientStreetName | string | Optional.

    This field contains the street name of the recipient address. | No | | senderAccountNumber | string | When present, this field contains the sender's account number. This field is mandatory in XB AFTs it will contain the destination account number being funded with the AFT (e.g. IBAN number for loading a bank account, proprietary wallet number for loading a wallet, prepaid PAN number for loading a card, money transfer operator proprietary account number with acquirer for funding a money transfer). | No | | senderMiddleInitial | string | This field contains sender's middle initial | No | | merchantCategoryCode | integer | Note:     If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned). | Yes | | recipientCountryCode | string | when present, this field contains recipient's country code

    Refer to ISO Codes | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ] } | | No | | senderCardExpiryDate | date | This field contains the expiration date for the sender's Visa account number or token in senderPrimaryAccountNumber
    Format: YYYY-MM
    Example: 2021-10 | Yes | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    Refer to businessApplicationId codes | Yes | | originalTransactionId | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated

    Note: Merchants must link the Merchant-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring, installment, and unscheduled COF), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions. | No | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial | No | | visaMerchantIdentifier | string | Visa Merchant Identifier | No | | addressVerificationData | { **"street"**: string, **"postalCode"**: string } | Conditional
    Address verification is required for an AFT transaction to qualify for CPS. Either send the card’s postal code or full address.

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Either the postalCode or full address of the card is required.

    Please reach out to your Visa representative for details. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | localTransactionDateTime | dateTime | This field contains the local date and time of the transaction takes place originated from merchant, service provider or acquirer.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | If present, this field should contain the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer } | Note: For a CardPresent Transactions, this field is required. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format: ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

    hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | argentinaReimbursementFee | double | Optional, when present, this field contains the Argentina member supplied reimbursement fee.
    Note:
    If a currency has one decimal place, the last digit of this field must be zero.
    If a currency has no decimal place, the last two digits of this field must be zero. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | optionalResponseParameters | string | Originators may choose to specify any or all of the following optional parameters to receive as part of the API response.

    E.g. Originators may specify comma-separated, optional parameters such as optionalResponseParameters (motoECIIndicator), if they want to receive motoECIIndicator in the API response.

    motoECIIndicator: Identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet) or the type of mail or telephone order. Acquirers supply indicator values, which V.I.P. forwards in requests and advices to issuers that have successfully tested to receive them. The subfield is dropped if issuers have not successfully completed testing or choose not to receive it.

    Refer to Moto ECI Codes

    E.g. optionalResponseParameters (motoECIIndicator) | No | | senderPrimaryAccountNumber | string | This is a 16-digit PAN or token of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator). Values in this field must be in the same currency and format as defined in the amount field. | No | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address. | No | | recipientIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)

    If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT

    This is an alphanumeric value that carries the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN) for the business issued to by the government or an authorized national entity, then this field needs to be populated for Argentina domestic transaction when businessApplicationId:PS | No | | recipientIdentificationNumberIndividual | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is an Individual (e.g. P2P payments)

    If recipientIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT
    | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation)

    Note: Supported only in US for CPS (Custom Payment Service).

    This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.

    Please reach out to your Visa representative for details. | No | #### PullFundsTransactionPostPayload-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | cavv | string | The Cardholder Authentication Verification Value (CAVV) is a value generated by an Access Control Server (ACS) and signed by the Issuer using account and password information of cardholders registered for the Verified by Visa (also known as Visa Secure) program. This field should be in hexabinary format. | No | | tavv | string | The Token Authentication Verification Value (TAVV) is a value generated using tokenized PAN by Visa Token Service (VTS) and signed by the Issuer. This field should be in hexabinary format.

    Note: A token should be send (instead of a PAN) in senderPrimaryAccountNumber field while sending a TAVV cryptogram. | No | | amount | double | The amount of the transaction, inclusive of all fees you assess for the transaction, including currency conversion fees. If the originator is populating the surcharge or foreignExchangeFeeTransaction field, they must be included in the amount field.
    Format:
    Minimum Value: 0
    Maximum value: 999999999.999
    Allowed fractional digits: 3
    Note: If a currency has three decimal places, the last digit of this field must be zero.
    If a currency has 0 minor unit, this field must carry no fractional points.
    If a currency has 2 minor units, the field must carry maximum two fractional points. | Yes | | pinData | { **"pinDataBlock"**: string, **"securityRelatedControlInfo"**: { **"zoneKeyIndex"**: integer, **"pinBlockFormatCode"**: integer } } | | No | | vauFlag | string | If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed) | No | | surcharge | string (double) | When present, this field contains the sender's surcharge as assessed by the originator. Values in this field must be in the same currency and format as defined in the amount field. | No | | senderCity | string | When present, this field contains sender's city | No | | senderName | string | Conditional.

    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use senderFirstName, sendertLastName & senderMiddleName instead.

    If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds.

    If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | accountType | string | This is used to identify the account type of the senderPrimaryAccountNumber in the request. Below are the possible values.

    00-Not applicable
    10-Saving account
    20-Checking account
    30-Credit card account
    40-Universal account

    Default is set to "00" if not provided. | No | | acquiringBin | integer | The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment. | Yes | | cardAcceptor | { **"name"**: string, **"taxID"**: string, **"idCode"**: string, **"address"**: { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string, **"addressLine"**: string }, **"terminalId"**: string, **"urlAddress"**: string, **"partnerIDCode"**: string, **"legalBusinessName"**: string, **"contactInformation"**: { **"phoneNumber"**: string, **"additionalContactDetails"**: string, **"customerServicePhoneNumber"**: string }, **"paymentFacilitator"**: { **"id"**: string, **"name"**: string, **"subMerchantId"**: string, **"independentSalesOrganizationID"**: string }, **"serviceLocationDetails"**: { **"address"**: { **"city"**: string, **"state"**: string, **"postalCode"**: string, **"countryCode"**: string } } } | | Yes | | cardCvv2Value | string | The cardCvv2Value value provided by the account holder for the senderPrimaryAccountNumber in the request. | No | | recipientCity | string | Conditional

    This field contains the city name of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientName | string | Conditional.

    Please do not use this field for non Visa transactions and for domestic Colombia transactions. Use recipientFirstName, recipientLastName & recipientMiddleName instead.

    This field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards.

    Recommended Format: Last Name/Family Surname 1 + Space + Last Name/Family Surname 2 (optional) + Space + First Name/Given Name + Space + Middle Initial or Middle name (optional) + space

    Example: Doe John A | No | | senderAddress | string | When present, this field contains sender's Address

    Note:
    This field is not applicable for domestic Colombia transactions | No | | memberComments | string | This field can be optionally used to send and receive comments by service providers. Issuers can optionally include new text in this field in the response. If the issuer does not include this field, Visa will inject the value from the request in the response and send it back to the service provider. | No | | recipientState | string | Required if RecipientCountryCode is either 124(CAN) or 840(USA)

    Note:
    This field is not applicable for domestic Colombia transactions | No | | senderLastName | string | Conditional

    This field contains sender's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderFirstName | string | Conditional

    This field contains sender's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | senderReference | string | If the transaction is a money transfer, pre-paid load, or credit card bill pay, and if the sender intends to fund the transaction with a non-financial instrument (for example, cash), a reference number unique to the sender is required.

    If the transaction is a funds disbursement, the field is required.

    This field is required if senderAccountNumber is not sent. | No | | senderStateCode | string | Conditional.

    Required if senderCountryCode is either 124(CAN) or 840(USA)

    Note:
    This field not applicable for domestic Colombia transactions | No | | purposeOfPayment | string | Conditional.

    This is an alphanumeric value.
    Purpose of payment is required in certain markets to clearly identify the purpose of the payment based on the standard values defined for respective market.
    For India, Bangladesh, Egypt and Argentina-Purpose of payment is mandatory for all BAIs except CO,CI and MP
    For Chile-Purpose of payment is mandatory for BAI-FD
    For Colombia-Purpose of payment is mandatory for BAI-AA and PP | No | | senderEntityType | string | Optional.

    This field identifies if the sender is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderMiddleName | string | This field contains sender's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    Maybe needed for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | senderPostalCode | string | When present, this field contains the sender's postal code

    Note: For domestic Colombia transactions, the maximum length of this field is 16 characters. For other transactions, the entered value should be between 5 and 10 characters. | No | | senderStreetName | string | Optional.

    This field contains the street name of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | sharingGroupCode | string | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to specify the network access priority.

    Refer to Sharing Group Code

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | chipConditionCode | integer | Optional.
    This field applies to magnetic stripe read transactions where the card and terminal are chip capable. The field does not apply to VSDC transactions where the chip is read; it is used only when the chip card's magnetic stripe is read instead of the chip.
    Valid values include:
    0- Not applicable to fallback transactions. For chip read transactions this field must contain a 0 or be excluded from the message.
    1 - This value applies to fallback transactions. Transaction was initiated from a magnetic stripe with a service code beginning with 2 or 6 and the last read at VSDC terminal was a successful chip read or was not a chip transaction.
    2- This value applies to fallback transactions. Transaction was initiated at a chip-capable terminal from a magnetic stripe that contains service code 2 or 6 , and the previous transaction initiated by that terminal was an unsuccessful chip read. | No | | merchantReference | string | Conditional.

    This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is "PS". | No | | messageReasonCode | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated.
    Note: Message reason code and POS Environment fields are mutually exclusive.

    Refer to Meassage Reason Codes | No | | recipientLastName | string | Conditional

    This field contains recipient's last name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 85 | No | | senderCountryCode | string | when present, this field contains sender's country code

    Refer to ISO Codes | No | | sourceOfFundsCode | string | when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.

    Refer to sourceOfFundsCode codes | No | | magneticStripeData | { **"track1Data"**: string, **"track2Data"**: string } | | No | | pointOfServiceData | { **"panEntryMode"**: integer, **"posEnvironment"**: string, **"motoECIIndicator"**: string, **"posConditionCode"**: integer, **"specialConditionIndicatorMerchant"**: string } | Contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
    Note: For a CardPresent Transactions, this field is required. | Yes | | recipientFirstName | string | Conditional

    This field contains recipient's first name

    Required for transaction routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 83 | No | | riskAssessmentData | { **"scpExemptionIndicator"**: string, **"traExemptionIndicator"**: string, **"lowValueExemptionIndicator"**: string, **"scaEnvironmentOutageIndicator"**: string, **"delegatedAuthenticationIndicator"**: string, **"trustedMerchantExemptionIndicator"**: string } | | No | | senderAddressLine1 | string | Optional.

    This field contains the first line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderAddressLine2 | string | Optional.

    This field contains the second line of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCurrencyCode | string | Use a 3-character alpha or numeric currency code for currency of the sender.

    Refer to ISO Codes | Yes | | acquirerCountryCode | integer | Use a 3-digit numeric country code for the country of the BIN under which your Visa Direct solution is registered. This must match the information provided during program enrollment.

    Refer to ISO Codes | Yes | | feeProgramIndicator | string | If present, a valid value is required. Spaces or special characters are not allowed. | No | | recipientEntityType | string | Optional.

    This field identifies if the recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | recipientMiddleName | string | This field contains recipient's middle name

    Used when transaction is routed over non Visa networks through Push Payment Gateway Service.

    This may also be required for Visa transactions for certain markets. Please check with your Visa contact.

    Maps to the following ISO 8583 field
    - Field 56, Tag 84 | No | | recipientPostalCode | string | Conditional

    This field contains the postal code of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientStreetName | string | This field contains the street name of the recipient address.

    Maps to the following ISO 8583 field
    - Field 56, Tag 88 | No | | senderAccountNumber | string | When present, this field contains the sender's account number. This field is mandatory in XB AFTs it will contain the destination account number being funded with the AFT (e.g. IBAN number for loading a bank account, proprietary wallet number for loading a wallet, prepaid PAN number for loading a card, money transfer operator proprietary account number with acquirer for funding a money transfer). | No | | senderMiddleInitial | string | This field contains sender's middle initial

    Note:
    This field is not applicable for domestic Colombia transactions | No | | merchantCategoryCode | integer | Note:     If provided, then the value overrides the one present in onboarding data. If the merchantCategoryCode value is not populated in onboarding data then this field is mandatory.

    If not provided, then the value will default to the values provided during onboarding (when the services are provisioned). | Yes | | recipientCountryCode | string | when present, this field contains recipient's country code

    Refer to ISO Codes | No | | senderAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"ancillarySenderDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ] } | | No | | senderBuildingNumber | string | Optional.

    This field contains the house or the building number of the sender address.

    Note:
    This field is only applicable for domestic Colombia transactions. For other transactions, if the field is provided, it will be dropped. | No | | senderCardExpiryDate | date | This field contains the expiration date for the sender's Visa account number or token in senderPrimaryAccountNumber
    Format: YYYY-MM
    Example: 2021-10 | Yes | | businessApplicationId | string | Identifies the programs' business application type for VisaNet transaction processing

    For Money Transfer, AA applies to transactions where the sender and recipient are the same person and PP applies to transactions where the sender and recipient are not the same person.

    For Argentina domestic purchase transactions the value should be "PS".

    Refer to businessApplicationId codes | Yes | | originalTransactionId | integer | Conditional.

    This field is required to identify whether a transaction is merchant-initiated

    Note: Merchants must link the Merchant-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring, installment, and unscheduled COF), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions. | No | | recipientAddressLine1 | string | Conditional.

    This field contains the first line of the recipient address.
    Note:
    It is required for cross-border transactions that are originating from or destined to Canada and for domestic Colombia transactions. | No | | recipientAddressLine2 | string | Optional.

    This field contains the second line of the recipient address. | No | | serviceProcessingType | { **"requestType"**: string } | Optional.

    This field will contain values that identify the type of service the transaction should be processed. | No | | recipientMiddleInitial | string | When present, this field contains recipient's middle initial

    Note:
    This field is not applicable for domestic Colombia transactions | No | | visaMerchantIdentifier | string | Visa Merchant Identifier assigned by Visa. | No | | addressVerificationData | { **"street"**: string, **"postalCode"**: string } | Conditional
    Address verification is required for an AFT transaction to qualify for CPS. Either send the card’s postal code or full address.

    Note:Supported only in US for CPS (Custom Payment Service). This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee.
    Either the postalCode or full address of the card is required.

    Please reach out to your Visa representative for details. | No | | merchantPseudoAbaNumber | string | This is a number that uniquely identifies the originator when they sign up to send Push Payment Gateway transactions. On enrollment, an originator will get a single pseudo-value that is assigned by Visa. The other networks will assign their own unique values for the originator.

    Note:
    Supported only in US for domestic transactions involving Push Payments Gateway Service. | No | | recipientAdditionalData | { **"identificationList"**: [ { **"idType"**: string, **"idNumber"**: string, **"idOwnerType"**: string, **"idIssueCountry"**: string } ], **"contactInformationList"**: [ { **"entityType"**: string, **"contactType"**: string, **"contactValue"**: string } ], **"ancillaryRecipientDetails"**: [ { **"address"**: { **"city"**: string, **"postalCode"**: string, **"streetName"**: string, **"countryCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string }, **"lastName"**: string, **"firstName"**: string, **"entityType"**: string, **"middleName"**: string } ] } | | No | | recipientBuildingNumber | string | Optional.

    This field contains the house or building number of the recipient address. | No | | systemsTraceAuditNumber | integer | A unique value should be used for each API method. However, when passing the (AFTR) method, this value must match the systemsTraceAuditNumber previously passed with the AFT method for the current transaction. | Yes | | enablerVerificationValue | binary | This field is to allow the application of the interchange discount at the enabler level. | No | | localTransactionDateTime | dateTime | This field contains the local date and time of the transaction takes place originated from merchant, service provider or acquirer.
    Format: YYYY-MM-DDThh:mm:ss
    Example: 2011-12-30T21:32:52 | Yes | | nationalReimbursementFee | double | If present, this field should contain the IRF fees. | No | | pointOfServiceCapability | { **"posTerminalType"**: integer, **"posTerminalEntryCapability"**: integer, **"acceptsPartialAuthorizations"**: string,
    **Available values:** "TRUE", "FALSE" } | Note: For a CardPresent Transactions, this field is required. | No | | retrievalReferenceNumber | string | A value used to tie together service calls related to a single financial transaction. When passing Account Funding Transaction (AFT) and Original Credit Transaction (OCT) methods, this value must differ between the two methods. When passing the Account Funding Transaction Reversal (AFTR) method, this value must match the retrievalReferenceNumber previously passed with the AFT method for this transaction.

    Recommended Format: ydddhhnnnnnn

    The first fours digits must be a valid yddd date in the Julian date format, where the first digit = 0-9 (last digit of current year) and the next three digits = 001-366 (number of the day in the year).

    hh can be the two digit hour in a 24 hour clock (00-23) during which the transaction is performed.

    nnnnnn can be the systemsTraceAuditNumber or any 6 digit number. | Yes | | integratedCircuitCardData | { **"amountCryptogram"**: double, **"countryCodeTerminal"**: string, **"formFactorIndicator"**: string, **"unpredictableNumber"**: string, **"applicationCryptogram"**: string, **"customerExclusiveData"**: string, **"issuerApplicationData"**: string, **"visaDiscretionaryData"**: { **"derivationKeyIndexVIS"**: string, **"cardVerificationResultsVIS"**: string, **"cryptogramVersionNumberVIS"**: string }, **"dateTerminalTransaction"**: string, **"amountCryptogramCashback"**: double, **"chipTransactionIndicator"**: integer, **"terminalCapabilityProfile"**: string, **"interfaceDeviceSerialNumber"**: string, **"terminalVerificationResults"**: string, **"amountCryptogramCurrencyCode"**: string, **"applicationInterchangeProfile"**: string, **"applicationTransactionCounter"**: string, **"cryptogramTransactionTypeCode"**: integer, **"amountCryptogramCashbackCurrencyCode"**: string, **"chipAuthenticationReliabilityIndicator"**: integer } | This field contains integrated circuit card (ICC)-related data that is transmitted in contact and contactless VSDC transactions from the ICC to the card issuer. | No | | merchantVerificationValue | { **"mvvVisaAssigned"**: string, **"mvvAcquirerAssigned"**: string } | Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant. | No | | mexicoNationalServiceData | { **"irfType"**: string, **"accountType"**: string, **"irfCategoryCode"**: string, **"merchantFiscalId"**: string, **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement. | No | | transactionLinkIdentifier | string | Transaction Link Identifier returned from other networks like MasterCard and Pulse | No | | optionalResponseParameters | string | Originators may choose to specify any or all of the following optional parameters to receive as part of the API response.

    E.g. Originators may specify comma-separated, optional parameters such as optionalResponseParameters (motoECIIndicator), if they want to receive motoECIIndicator in the API response.

    motoECIIndicator: Identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet) or the type of mail or telephone order. Acquirers supply indicator values, which V.I.P. forwards in requests and advices to issuers that have successfully tested to receive them. The subfield is dropped if issuers have not successfully completed testing or choose not to receive it.

    Refer to Moto ECI Codes

    E.g. optionalResponseParameters (motoECIIndicator) | No | | senderPrimaryAccountNumber | string | This is a 16-digit PAN or token of the sender's account. | Yes | | settlementServiceIndicator | integer | This flag enables the originator to request for a particular settlement service to be used for settling the transaction.

    Valid values are:
    0 - International Settlement
    9 - VIP to decide
    8 - National Settlement

    Note: The default value is 9. This field is only relevant for specific countries where the acquirer has to select 8 in order to settle in the national net settlement service. | No | | colombiaNationalServiceData | { **"addValueTaxAmount"**: double, **"addValueTaxReturn"**: double, **"taxAmountConsumption"**: double, **"nationalNetMiscAmount"**: double, **"emvTransactionIndicator"**: string, **"costTransactionIndicator"**: string, **"nationalChargebackReason"**: integer, **"nationalReimbursementFee"**: double, **"nationalNetMiscAmountType"**: string, **"countryCodeNationalService"**: integer, **"nationalNetReimbursementFeeBaseAmount"**: double } | Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement | No | | argentinaNationalServiceData | { **"reimbursementFee"**: double, **"reimbursementFeeTax"**: double } | Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement. | No | | foreignExchangeFeeTransaction | double | When present, this field contains the sender's foreign exchange markup fee (markup above the wholesale or VisaNet exchange rate as assessed by the originator). Values in this field must be in the same currency and format as defined in the amount field. | No | | recipientSubDivisionMinorCode | string | Optional.

    This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address.

    Note:
    This field is not applicable for domestic Colombia transactions | No | | recipientAccountIdentificationData | { **"recipientAccountIdentifierValue"**: string, **"recipientAccountIdentifierTypeCode"**: string } | | No | | recipientIdentificationNumberBusiness | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is a business (e.g. Disbursements)

    If recipientIdentificationNumberIndividual is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT

    For Argentina domestic purchase transactions this field contains the merchant’s value-added tax (VAT) registration number or single business reference number (SBRN). | No | | recipientIdentificationNumberIndividual | string | Conditional.

    This is an alphanumeric value that carries the recipient's identification number issued to the recipient by the government or an authorized national entity. This field is to be used if the recipient is an Individual (e.g. P2P payments)

    If recipientIdentificationNumberBusiness is not populated, then this field needs to be populated mandatorily for Brazil domestic trasactions when businessApplicationId has any of the below values:

    AA
    PP
    TU
    BI
    WT
    FT
    | No | | cpsAuthorizationCharacteristicsIndicator | string | Conditional
    Request for CPS authorization. If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (Transaction requests participation)

    Note: Supported only in US for CPS (Custom Payment Service).

    This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid the Transaction Integrity Fee.

    Please reach out to your Visa representative for details. | No | #### CashOutRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | encAgentPAN | string | Agent PAN. 16-digit PAN as created from the mVisa agent ID captured by the consumer from agent information display option. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | Yes | | originatorBIN | string | This BIN number identifies the originator of Cash-Out payment transaction. | Yes | | encConsumerPAN | string | Consumer PAN. This is a 16-digit PAN. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). The field data type will be string(16-19) after decryption. | No | | encConsumerName | string | Consumer name. If consumer name is greater than 30 characters, then only first 30 characters will be expected. The field is sent in encrypted format using the AES GCM (i.e. Advanced Encryption Standard (AES) in Galois/Counter Mode (GCM)) algorithm for JSON Web Encryption (JWE) objects with 256-bit key (i.e. the shared secret between Visa and client for encryption and decryption of payload data). | Yes | | otherPhoneNumber | string | Conditional. When present, this field contains the sender's phone number. This field is applicable only for merchant payment transaction. Originator should populate the consumer mobile number if captured on the mobile app for this transaction. Data should not exceed 16 alphanumeric characters. | No | | otherEmailAddress | string | Conditional. When present, this field contains the sender's email address. This field is applicable only for merchant payment transaction. Originator should populate the consumer email address if captured on the mobile app for this transaction. Data should not exceed 99 alphanumeric characters. | No | | transactionAmount | string | Transaction amount in agent on currency. In case the agent currency is not the same as the consumer currency, then originator will perform currency conversion before submitting the transaction. | Yes | | visaTransactionId | string | Numeric. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | localTransactionDate | string (mmdd) | It contains the local month and day on which the transaction was originated. The date is in mmdd format. | Yes | | localTransactionTime | string (hhmmss) | The time the transaction takes place, expressed in the local time of the originator. The time is in hhmmss format. | Yes | | transmissionDateTime | string (MMDDhhmmss) | The date and time the request was submitted to Visa. Format: MMDDhhmmss. | Yes | | originatorCountryCode | string | A 3-digit ISO-4217 code that identifies the country of the originating BIN.
    Refer to ISO codes. | Yes | | systemTraceAuditNumber | string | Numeric. It is a key data element used to match a response to its request or to match a message to others for a given transaction. | Yes | | velocityLimitIndicator | string | Conditional. This field contains the velocity limit related information that Acquirer can use in making the authorization decision:
    • 1 = 1-day count or amount exceeded.
    • 2 = 7-day count or amount exceeded.
    • 3 = 30-day count or amount exceeded.
    The field is populated with priority of 1, 2 and then 3.
    This field is sent if recipient has opted for VisaNet to forward them the OCT when a velocity limit has been exceeded.
    This field will be sent as NULL if it is not populated. | No | | transactionCurrencyCode | string | The 3-digit ISO-4217 code in this field reflects the currency associated to the transactionAmount field. | Yes | | decimalPositionIndicator | string | Indicates the number of decimal positions following the amount field. This field is to be sent as NULL if it is not populated. | Yes | | enablerVerificationValue | string | This field is to allow the application of the interchange discount at the enabler level. | No | | retrievalReferenceNumber | string | Numeric. It is a key data element for matching a message to others within a given transaction set. The same number appears in all related messages: response, advice, reversal, chargeback, chargeback reversal, or representment. The format is recommended to be ydddhhnnnnnn. | Yes | #### GetReportResponse-1 Schema Response data when a merchant or agent alias is successfully resolved. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | _links | { **"last"**: string, **"next"**: string, **"self"**: string, **"first"**: string, **"previous"**: string } | This contains the navigation url links of the report, i.e. 'self', 'first', 'next'(if applicable),'previous'(if applicable),'last'(if applicable). | Yes | | content | { **"guid"**: string, **"status"**: string, **"aliasId"**: string, **"merchantId"**: string } | Depending on the selected type of alias reports, this contains a list of consumer, merchant or agent alias records. | Yes | #### CreateAliasRequest-3 Schema Request payload data for creating an alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city belonging to the payment instrument | No | | guid | string | This attribute is uniquely used by an Issuer to identify the payment instrument belonging to a consumer cardholder.
    An Issuer may pass their existing unique identifier of a cardholder's payment instrument in their system to Visa Alias Directory Service as a guid.

    One alias can be linked to more than one account. For example, one phone can be linked to three different cards with one of these cards selected as the default card to receive money. It is recommended that the Issuer use systematic naming to generate a guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3

    If an issuer creates a new Alias with a guid that is already associated with another Alias, the existing record will be deleted and the new Alias will be created. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Ukraine38038067xxxxxxx
    Belarus37537529xxxxxxx
    Kazakhstan77701xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx
    | Yes | | country | string | Country code belonging to the payment instrument of the consumer as defined by ISO 3166. The country code will be stored in ISO3166-Alpha3 format for standardization purposes. | Yes | | address1 | string | Address line 1 belonging to the payment instrument | No | | address2 | string | Address line 2 belonging to the payment instrument | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum | Yes | | aliasType | string | “01” – Phone number
    “02” – Email address | Yes | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money. | No | | expiryDate | string | Consumer's card expiration date. Format: YYYY-MM. | Yes | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Postal code belonging to the payment instrument of the consumer | No | | paymentType | string | Only “PAN” is accepted. Values such as “” or “pan” will be defaulted to “PAN”. All other values will be rejected. | No | | contactEmail | string | Consumer’s contact email for communications | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal data for the Visa Alias Directory Service. Format: YYYY-MM-DD hh:mm:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | Yes | | recipientLastName | string | Consumer’s last name. Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for communications | No | | recipientFirstName | string | Consumer’s first name | Yes | | recipientMiddleName | string | Consumer’s middle name | No | | recipientLastNameLocal | string | Consumer’s last name in local language, Issuers in Ukraine, Kazakhstan, Uzbekistan, Belarus, Moldova, Armenia, Azerbaijan, Georgia, Kyrgyzstan, and Tajikistan must use only the first letter of a customer’s last name followed by a dot symbol to create or modify an alias record. For example, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' | No | | recipientFirstNameLocal | string | Consumer’s first name in local language | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language | No | | recipientPrimaryAccountNumber | string | Consumer's card number | Yes | #### CashInPushPaymentResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | actionCode | string | Contains a code that defines the response to a request.
    Refer to actionCode | Yes | | approvalCode | string | Conditional. Contains the authorization code provided by the participant when a transaction is approved. | Yes | | responseCode | string | It is added by VisaNet and contains the response source/reason code that identifies the source of the field actionCode response decision. | Yes | | statusIdentifier | string | Required when the API response times out. | No | | originalActionCode | string | The action code of the original transaction request
    Refer to actionCode
    Note: This field is only present, when the request is identified as a duplicate. | No | | transmissionDateTime | string (dat-time) | The value in response must match the value in the request. | Yes | | transactionIdentifier | string | It is added by VisaNet. It contains a right-justified, VisaNet generated Transaction Identifier (TID) that is unique for each request. The identifier links original messages to subsequent messages, such as those for exception item processing and clearing record. | Yes | | enablerVerificationValue | string | Enabler Verification Value (EVV) is a Visa assigned value that is used to identify enablers that participate in certain programs. The EVV is unique to the enabler. | No | | retrievalReferenceNumber | string | Numeric only. Key data element for matching a message to others within a given transaction set. Value will be the same as what has been provided in the request. | Yes | #### CreateAliasRequest-2 Schema Request payload data for creating an alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | Consumer’s city | No | | guid | string | This attribute is uniquely used by Issuer to identify their customer (i.e. consumer cardholder).
    Issuer may pass their existing unique identifier of a cardholder of their system to VAD as a guid.

    For multiple aliases linked to the same PAN, same guid should be used except changing the field alias in the request payload. Below is an example:
    guid abcd12345678z01, alias 85291112222
    guid abcd12345678z01, alias 85288881111.

    For selected countries, one alias can be linked to more than one account, e.g. one mobile can be linked to three different cards with a default card to receive money. It is recommended that issuer to use systematic naming to generate guid for easy maintenance. Below is an example of one mobile number linking to three different PANs:
    alias 85291112222, guid abcd12345678z01 for PAN1 (default)
    alias 85291112222, guid abcd12345678z02 for PAN2
    alias 85291112222, guid abcd12345678z03 for PAN3, etc. | Yes | | alias | string | This attribute contains the alias data, e.g. phone number, email address, etc.
    If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Below are some examples of phone numbers with different country codes:
    CountryCountry CodeExamples
    United States11650xxxxxxx
    Russia77495xxxxxxx
    United Kingdom444478xxxxxxxx
    Singapore65659xxxxxxx
    Hong Kong8528529xxxxxxx
    Kenya254254701xxxxxx

    If IBAN (International Bank Account Number) is used for alias, this should be provided in accordance with ISO 13616:2007. Below is an example of IBAN:

    CountryExample
    IrelandIE29AIBK93115212345678
    where
    Country Code: IE
    Check digits: 29
    Bank Identifier: AIBK
    Branch Identifier: 931152
    Account Number:12345678
    | Yes | | country | string | Consumer’s country code as defined by ISO 3166, ISO 3166 alpha-2 is recommended to be used if alias may be used for QR. | Yes | | address1 | string | Address line 1. | No | | address2 | string | Address line 2. | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum | Yes | | aliasType | string | “01” – Phone number
    “02” – Email address
    “03” – National ID
    “04” – IBAN (International Bank Account Number) | Yes | | isDefault | string | Conditional. This attribute is to accept either 'true' or 'false'. If set as 'true', this consumer's card number will be set as the default card to receive money.
    Note. This attribute is mandatory to selected markets that allow to have one alias linked to multiple accounts. | No | | expiryDate | string | Conditional. Consumer's card expiration date. Format: YYYY-MM.
    Note. This attribute is only applicable to selected markets. | No | | issuerName | string | This is the Issuer name of recipient’s card | Yes | | postalCode | string | Postal/Zip code of the consumer. | No | | paymentType | string | Only accept value 'PAN'. | No | | accountEmail | string | Conditional. This field should only be used for selected markets that opt to use Visa web portal for alias registration. This is a consumer email address for communications and matching purposes. If the account email does not match with existing alias mappings, the existing alias mappings will be disabled prior to creating the new alias mapping. | No | | contactEmail | string | Consumer’s contact email for communications. | No | | consentDateTime | string | Date & time when consumer has provided their consent to Issuer about the use of their personal data for VAD service. Format: YYYY-MM-DD hh:mm:ss. Local date and time should be converted to Coordinated Universal Time (UTC) before submitting this value in API request. | Yes | | recipientLastName | string | Consumer’s last name. | Yes | | contactPhoneNumber | string | Consumer’s contact phone number for communications | No | | recipientFirstName | string | Consumer’s first name. | Yes | | recipientMiddleName | string | Consumer’s middle name. | No | | recipientLastNameLocal | string | Consumer’s last name in local language. | No | | recipientFirstNameLocal | string | Consumer’s first name in local language. | No | | recipientMiddleNameLocal | string | Consumer’s middle name in local language. | No | | recipientPrimaryAccountNumber | string | Consumer's card number. | Yes | #### CardAcceptormr Schema This must be the same value as in the original response. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | name | string | This must be the same value as in the original response. | No | | idCode | string | Originator should populate this field with the card acceptor ID (Merchant ID) of the merchant. | No | | address | { **"city"**: string, **"state"**: string, **"county"**: string, **"country"**: string, **"zipCode"**: string } | | No | | terminalId | string | Conditional. Originators can drop this field only when the acquiring BIN is mVisa enabled. | No |