# Funds Transfer API
## Create Reverse Funds Transaction
> Create Reverse Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/reversefundstransactions":{"post":{"tags":["Funds Transfer API"],"summary":"Create Reverse Funds Transaction","description":"Create Reverse Funds Transaction","operationId":"createReverseFundsTransaction","requestBody":{"description":"Request body for creating in reverse funds transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReverseFundsTransactionPostPayload-3"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReverseFundsTransactionPostPayload-3"}}},"required":true},"responses":{"200":{"description":"Reverse Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReverseFundsTransactionPostResponse-2"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReverseFundsTransactionPostResponse-2"}}}}}}}},"components":{"schemas":{"ReverseFundsTransactionPostPayload-3":{"required":["acquirerCountryCode","acquiringBin","amount","businessApplicationId","cardAcceptor","localTransactionDateTime","merchantCategoryCode","originalDataElements","retrievalReferenceNumber","senderCurrencyCode","systemsTraceAuditNumber","transactionIdentifier"],"type":"object","properties":{"amount":{"type":"number","description":"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.","format":"double"},"networkId":{"type":"integer","description":"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."},"surcharge":{"maxLength":13,"minLength":1,"type":"string","description":"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.","format":"double"},"tokenData":{"type":"object","properties":{"tokenAssuranceMethod":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains different category value to determine the Risk Score associated with the token and transaction."}},"description":"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."},"accountType":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"acquiringBin":{"type":"integer","description":"The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment."},"cardAcceptor":{"required":["address","idCode","name","terminalId"],"type":"object","properties":{"name":{"maxLength":25,"minLength":1,"type":"string","description":"This field should contain the name of the originator or the money transfer operator."},"idCode":{"maxLength":15,"minLength":1,"type":"string","description":"An identifier for the card acceptor (Visa Direct Originator). This value should be unique for each originator for whom you are sending transactions."},"address":{"required":["country"],"type":"object","properties":{"state":{"maxLength":2,"minLength":2,"type":"string","description":"Use a 2-character abbreviated states code or territory code as the state value."},"county":{"maxLength":3,"minLength":3,"type":"string"},"country":{"maxLength":3,"minLength":3,"type":"string","description":"This field must contain the 3-character alpha country code for the country of the originator or money transfer operator.
Refer to ISO Codes"},"zipCode":{"maxLength":9,"minLength":5,"type":"string","description":" "}}},"terminalId":{"maxLength":8,"minLength":1,"type":"string","description":"The identifier for the terminal at a card acceptor location. If sending transactions from a card not present environment, use the same value for all transactions."}}},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"senderReference":{"maxLength":16,"type":"string","description":"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."},"schemeIdentifier":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"sharingGroupCode":{"maxLength":30,"type":"string","description":"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."},"merchantReference":{"maxLength":35,"type":"string","description":"This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is \"PS\"."},"pointOfServiceData":{"type":"object","properties":{"panEntryMode":{"type":"integer","description":"For a CardPresent scenario, this field is required."},"motoECIIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"Note: If posConditionCode is 59, motoECIIndicator must be between 5-8. Default is set to 5 if not provided. If posConditionCode is 0, motoECIIndicator will not be sent."},"posConditionCode":{"type":"integer","description":"For a CardPresent scenario, this field is required."},"specialConditionIndicatorMerchant":{"maxLength":1,"minLength":1,"type":"string","description":"1 – Purchase of Central Bank Digital Currency (CBDC) or Tokenized Deposits
2 – Purchase of Stablecoin (fiat-backed)
3 – Purchase of Blockchain Native Token/Coin
7* - Purchase of Cryptocurrency"}}},"senderCurrencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Use a 3-character alpha or numeric currency code for currency of the original transaction.
Refer to ISO Codes"},"acquirerCountryCode":{"type":"integer","description":"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."},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string","description":"If present, a valid value is required. Spaces or special characters are not allowed."},"merchantCategoryCode":{"type":"integer","description":"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"},"originalDataElements":{"type":"object","properties":{"acquiringBin":{"type":"integer","description":"This field must contain the Bank Identification Number (BIN) from the original AFT."},"approvalCode":{"maxLength":6,"minLength":6,"type":"string","description":"This field, if present, must contain the approvalCode from the original AFT."},"transmissionDateTime":{"type":"string","description":"This field must contain the transmissionDateTime from the original AFT
Example: 2016-01-15T07:03:52","format":"date-time"},"systemsTraceAuditNumber":{"type":"integer","description":"This field must contain the systemsTraceAuditNumber from the original AFT."}}},"senderCardExpiryDate":{"type":"string","description":"The expiration date for the sender's Visa account number in senderPrimaryAccountNumber."},"businessApplicationId":{"maxLength":2,"minLength":2,"type":"string","description":"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"},"serviceProcessingType":{"type":"object","properties":{"requestType":{"maxLength":2,"type":"string","description":"Reserved for future use."}},"description":"Optional.
This field will contain values that identify the type of service the transaction should be processed."},"transactionIdentifier":{"maximum":15,"minimum":15,"type":"integer","description":"The VisaNet reference number for the transaction. You must use the transactionIdentifier from the initial AFT in this field.","format":"int64"},"visaMerchantIdentifier":{"maxLength":8,"minLength":8,"type":"string","description":"Visa Merchant Identifier assigned by Visa."},"merchantPseudoAbaNumber":{"maxLength":9,"minLength":9,"type":"string","description":"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."},"systemsTraceAuditNumber":{"type":"integer","description":"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."},"enablerVerificationValue":{"type":"string","description":"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.","format":"binary"},"localTransactionDateTime":{"type":"string","format":"date-time"},"nationalReimbursementFee":{"maximum":13,"minimum":1,"type":"number","description":"When present, this field contains the IRF fees.","format":"double"},"pointOfServiceCapability":{"type":"object","properties":{"posTerminalType":{"type":"integer","description":"Note: Valid values if card is present include 0, 3 and 4. If card is not present, valid value is 5."},"posTerminalEntryCapability":{"maximum":1,"type":"integer","description":"Note: Valid values if card is present include 0, 2 and 9. If card is not present, valid value is 1."}}},"retrievalReferenceNumber":{"maxLength":12,"minLength":12,"type":"string","description":"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."},"merchantVerificationValue":{"required":["mvvAcquirerAssigned","mvvVisaAssigned"],"type":"object","properties":{"mvvVisaAssigned":{"maxLength":6,"minLength":6,"type":"string","description":"Visa assigned MVV value. E.g. 0A45AF"},"mvvAcquirerAssigned":{"maxLength":4,"minLength":4,"type":"string","description":"Visa assists the acquirer in assigning the last four. E.g. 98FC"}},"description":"Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant."},"mexicoNationalServiceData":{"required":["reimbursementFee","reimbursementFeeTax"],"type":"object","properties":{"irfType":{"maxLength":1,"minLength":1,"type":"string","description":"This field contains one of the following values:
0 - Unknown/default
1 - Fixed
2 - Ad valorem (%)
3 - Composite (fixed amount and ad valorem)"},"accountType":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains one of the following values:
CO - Commercial products
CR - Credit
DB - Debit
PL - Private label
PP - Prepaid"},"irfCategoryCode":{"maxLength":2,"minLength":1,"type":"string","description":"This field optionally contains any value from 00 to 99."},"merchantFiscalId":{"maxLength":13,"type":"string","description":"This field contains RFC for the merchant. This is an alphanumeric field. The RFC format can be AAAANNNNNNAAA, where A is alphanumeric value and N is a numeric value."},"reimbursementFee":{"type":"number","description":"This field contains the Client-Calculated Interchange Reimbursement Fee in the same currency as the transaction. It must not contain zeros.","format":"double"},"reimbursementFeeTax":{"type":"number","description":"This field contains the VAT calculated for the IRF applicable to the transaction. It must not contain zeros.","format":"double"}},"description":"Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement."},"senderPrimaryAccountNumber":{"maxLength":19,"minLength":13,"type":"string","description":"The primary account number of the sender's account."},"settlementServiceIndicator":{"maximum":1,"minimum":1,"type":"integer","description":"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. "},"colombiaNationalServiceData":{"required":["countryCodeNationalService","nationalNetReimbursementFeeBaseAmount"],"type":"object","properties":{"addValueTaxAmount":{"type":"number","description":"This is the national government tax for added value of good or service.","format":"double"},"addValueTaxReturn":{"type":"number","description":"This is base value of the IVA (Sales tax). Optional. This field indicates base value of the IVA ( Sales tax which is part of the benefit of the tax legislations for the 2% sale tax return to the cardholder.","format":"double"},"taxAmountConsumption":{"type":"number","description":"This is the national consumption tax amount.","format":"double"},"nationalNetMiscAmount":{"type":"number","description":"This is an amount field that contains an airport charge, cashback or a tip.","format":"double"},"emvTransactionIndicator":{"maxLength":1,"type":"string","description":"Contains one of the below valid values:
0 - Does not apply to EMV
1 - EMV transaction
2 - Fallback transaction"},"costTransactionIndicator":{"maxLength":1,"type":"string","description":"Contains one of the below valid values:
0 - Not a cost inquiry amount
1 - Cost inquiry transaction"},"nationalChargebackReason":{"type":"integer","description":"Contains a domestic chargeback reason code."},"nationalReimbursementFee":{"type":"number","description":"Numeric entry indicating a fee for a National Settlement transaction. It must be zeros unless the transaction is a National Settlement transaction for a country using this capability. Two decimal positions are implied.","format":"double"},"nationalNetMiscAmountType":{"maxLength":1,"type":"string","description":"It identifies the type of the miscellaneous amount – i.e. whether it is one of:
A - Airport charge
C - Cashback
T - Tip
Must be one of the above valid values if nationalNetMiscAmount > 0.
Must be skipped if nationalNetMiscAmount = 0."},"countryCodeNationalService":{"type":"integer","description":"The acquirer's country code. Must be 170 for Colombia."},"nationalNetReimbursementFeeBaseAmount":{"type":"number","description":"The client supplied interchange reimbursement amount expressed in the transaction currency. This must be less than the transaction amount.","format":"double"}},"description":"Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement"},"argentinaNationalServiceData":{"required":["reimbursementFee"],"type":"object","properties":{"reimbursementFee":{"type":"number","description":"This field contains the Argentina member supplied reimbursement fee. This value should be greater than 0 for Argentina Domestic Purchase transactions.","format":"double"},"reimbursementFeeTax":{"type":"number","description":"Conditional.
This field contains the VAT calculated for the IRF applicable to the transaction.","format":"double"}},"description":"Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement."},"foreignExchangeFeeTransaction":{"type":"number","description":"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).","format":"double"},"senderPaymentCredentialReference":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["PCI_TOKEN_REFID"]},"value":{"maxLength":75,"minLength":1,"type":"string"},"merchantId":{"maxLength":50,"minLength":1,"type":"string","description":"Conditional
Unique Merchant Identification assigned by Token Service Provider. "}},"description":"Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID\n\nConditional\nOnly one of 'senderPrimaryAccountNumber' and 'senderPaymentCredentialReference' is provided in a request\n"},"masterCardMerchantPaymentGatewayId":{"maxLength":11,"minLength":1,"type":"string","description":"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."},"recipientIdentificationNumberBusiness":{"maxLength":20,"type":"string","description":"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."}}},"ReverseFundsTransactionPostResponse-2":{"required":["actionCode","responseCode","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"networkId":{"type":"integer","description":"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."},"tokenData":{"type":"object","properties":{"tokenAssuranceMethod":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains different category value to determine the Risk Score associated with the token and transaction."}},"description":"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."},"actionCode":{"maxLength":2,"minLength":2,"type":"string","description":"The results of the transaction request
Refer to actionCode
Note: The VisaNet Response Code for the transaction"},"last4ofPAN":{"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"maxLength":6,"minLength":6,"type":"string","description":"The authorization code from the issuer."},"responseCode":{"maxLength":1,"minLength":1,"type":"string","description":"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"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"settlementFlags":{"required":["settlementResponsibilityFlag"],"type":"object","properties":{"givUpdatedFlag":{"maxLength":5,"minLength":5,"type":"string","description":"Possible values are true or false"},"settlementServiceFlag":{"maxLength":1,"minLength":1,"type":"string","description":"Possible values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement
"},"givPreviouslyUpdatedFlag":{"maxLength":5,"minLength":5,"type":"string","description":"Possible values are true or false"},"settlementResponsibilityFlag":{"maxLength":5,"minLength":5,"type":"string","description":"Possible values are true or false"}},"description":""},"statusIdentifier":{"type":"string"},"customerReference":{"maxLength":17,"type":"string","description":"This field contains a value that identifies the customer.
This field needs to be populated for Argentina domestic purchase transactions where businessApplicationId is \"PS\"."},"responseReasonCode":{"maxLength":4,"minLength":1,"type":"string","description":"This field contains the merchant advice code value received from Mastercard authorization response messages."},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string"},"transmissionDateTime":{"type":"string","description":"Example: 2016-01-15T07:03:52.000Z","format":"date-time"},"serviceProcessingType":{"type":"object","properties":{"requestType":{"maxLength":2,"type":"string","description":"Reserved for future use."}},"description":"This field will contain values that identifies the type of service assigned for the transaction."},"transactionIdentifier":{"maximum":15,"minimum":15,"type":"integer","description":"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.","format":"int64"},"additionalTokenRespInfo":{"maxLength":1,"minLength":1,"type":"string","description":"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."},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"merchantVerificationValue":{"maxLength":10,"minLength":10,"type":"string","description":"The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned."},"transactionLinkIdentifier":{"maxLength":36,"minLength":1,"type":"string","description":"Transaction Link Identifier returned from other networks like MasterCard and Pulse"},"senderIdentificationNumberIndividual":{"maxLength":13,"type":"string","description":"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"}}}}}}
```
## Read Multi Pull Funds Transaction
> Read Multi Pull Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/multipullfundstransactions/{statusIdentifier}":{"get":{"tags":["Funds Transfer API"],"summary":"Read Multi Pull Funds Transaction","description":"Read Multi Pull Funds Transaction","operationId":"readMultiPullFundsTransaction","parameters":[{"name":"statusIdentifier","in":"path","description":"Status Identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pull Multi Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPullFundsTransactionGetResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiPullFundsTransactionGetResponse"}}}}}}}},"components":{"schemas":{"MultiPullFundsTransactionGetResponse":{"required":["actionCode","responseCode","statusIdentifier","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"actionCode":{"type":"string","description":"The results of the transaction request
Refer to actionCode
Note: : The VisaNet Response Code for the transaction"},"last4ofPAN":{"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"type":"string","description":"The authorization code from the issuer."},"responseCode":{"type":"string","description":"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"},"cavvResultCode":{"type":"string","description":"The cavvResultCode identifies the outcome of the CAVV validation.
Refer to cavvResultCode"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"settlementFlags":{"required":["settlementResponsibilityFlag"],"type":"object","properties":{"givUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementServiceFlag":{"type":"string","description":"Possible values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement
"},"givPreviouslyUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementResponsibilityFlag":{"type":"string","description":"Possible values are true or false"}},"description":""},"statusIdentifier":{"type":"string"},"customerReference":{"type":"string","description":"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."},"originalActionCode":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"feeProgramIndicator":{"type":"string"},"transmissionDateTime":{"type":"string","description":"Example: 2016-01-15T07:03:52.000Z
Note: Remove \"000Z\" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request.","format":"date-time"},"transactionIdentifier":{"type":"integer","description":"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.","format":"int64"},"reimbursementAttribute":{"type":"string","description":"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."},"enablerVerificationValue":{"type":"string","description":"This field is to allow the application of the interchange discount at the enabler level.","format":"binary"},"recipientIdentificationNumberIndividual":{"type":"string","description":"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)"},"cpsAuthorizationCharacteristicsIndicator":{"type":"string","description":"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."}}}}}}
```
## Create Multi Pull Funds Transaction
> Create Multi Pull Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/multipullfundstransactions":{"post":{"tags":["Funds Transfer API"],"summary":"Create Multi Pull Funds Transaction","description":"Create Multi Pull Funds Transaction","operationId":"createMultiPullFundsTransaction","requestBody":{"description":"Request body for creating in multi pull funds transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPullFundsTransactionPostPayload-1"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiPullFundsTransactionPostPayload-1"}}},"required":true},"responses":{"200":{"description":"Multi Pull Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPullFundsTransactionPostResponse-1"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiPullFundsTransactionPostResponse-1"}}}}}}}},"components":{"schemas":{"MultiPullFundsTransactionPostPayload-1":{"required":["acquirerCountryCode","acquiringBin","localTransactionDateTime","request"],"type":"object","properties":{"request":{"type":"array","items":{"$ref":"#/components/schemas/MultiPullFundsTransactionRequests-1"}},"acquiringBin":{"type":"integer","description":"The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment."},"acquirerCountryCode":{"type":"integer","description":"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"},"merchantCategoryCode":{"type":"integer","description":"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)."},"businessApplicationId":{"maxLength":2,"minLength":2,"type":"string","description":"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"},"localTransactionDateTime":{"type":"string","description":" ","format":"date-time"}}},"MultiPullFundsTransactionRequests-1":{"required":["amount","cardAcceptor","localTransactionDateTime","pointOfServiceData","retrievalReferenceNumber","senderCardExpiryDate","senderCurrencyCode","senderPrimaryAccountNumber","systemsTraceAuditNumber"],"type":"object","properties":{"cavv":{"maxLength":40,"minLength":40,"type":"string","description":"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."},"amount":{"type":"number","description":"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.","format":"double"},"pinData":{"type":"object","properties":{"pinDataBlock":{"maxLength":16,"type":"string","description":"For a CardPresent with PIN Data scenario, this field is required."},"securityRelatedControlInfo":{"type":"object","properties":{"zoneKeyIndex":{"type":"integer","description":"Note: For a CardPresent with PIN Data scenario, this field is required."},"pinBlockFormatCode":{"type":"integer","description":"Note: For a CardPresent Transactions, this field is required."}}}}},"surcharge":{"maxLength":13,"minLength":1,"type":"string","description":"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.","format":"double"},"senderCity":{"maxLength":25,"minLength":1,"type":"string","description":"When present, this field contains sender's city"},"cardAcceptor":{"required":["address","idCode","name","terminalId"],"type":"object","properties":{"name":{"maxLength":25,"minLength":1,"type":"string","description":"name of the originator/money transfer operator."},"idCode":{"maxLength":15,"minLength":1,"type":"string","description":"An identifier for the card acceptor (Visa Direct Originator). This value should be unique for each originator for whom you are sending transactions."},"address":{"required":["country"],"type":"object","properties":{"state":{"maxLength":2,"minLength":2,"type":"string","description":"Note: state or province of the money transfer operator/Originator.
Required if cardAcceptor:address:country is \"US\" or \"CA\"."},"county":{"maxLength":3,"minLength":3,"type":"string","description":"Note: It contains 3-digit numeric FIPS county code of the money transfer operator/Originator.
Required if cardAcceptor:address:country is \"US\"."},"country":{"maxLength":3,"minLength":3,"type":"string","description":"This field must contain the 3-character alpha country code for the country of the originator or money transfer operator.
Refer to ISO Codes"},"zipCode":{"maxLength":9,"minLength":5,"type":"string","description":"Note: Zip/Postal code of the money transfer operator/Originator.
Required if cardAcceptor:address:country is \"US\" or \"CA\"."}}},"terminalId":{"maxLength":8,"minLength":1,"type":"string","description":"The identifier for the terminal at a card acceptor location. If sending transactions from a card not present environment, use the same value for all transactions."}}},"cardCvv2Value":{"maxLength":4,"minLength":3,"type":"string","description":"The cardCvv2Value provided by the account holder for the senderPrimaryAccountNumber in the request."},"senderAddress":{"maxLength":35,"minLength":1,"type":"string","description":"When present, this field contains sender's Address"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"recipientState":{"maxLength":3,"type":"string","description":"Required if RecipientCountryCode is either 124(CAN) or 840(USA)"},"senderLastName":{"maxLength":35,"type":"string","description":"This field contains sender's last name"},"senderFirstName":{"maxLength":35,"type":"string","description":"This field contains sender's first name"},"senderReference":{"maxLength":16,"type":"string","description":"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."},"senderStateCode":{"maxLength":2,"minLength":2,"type":"string","description":"When present, this field contains sender's state code"},"senderPostalCode":{"type":"string","description":"When present, this field contains the sender's postal code"},"sharingGroupCode":{"maxLength":30,"type":"string","description":"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."},"merchantReference":{"maxLength":35,"type":"string","description":"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."},"messageReasonCode":{"type":"integer","description":"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"},"recipientLastName":{"maxLength":35,"type":"string","description":"When present, this field contains recipient's last name"},"senderCountryCode":{"maxLength":3,"minLength":2,"type":"string","description":"when present, this field contains sender's country code
Refer to ISO Codes"},"sourceOfFundsCode":{"maxLength":2,"minLength":2,"type":"string","description":"when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.
Refer to sourceOfFundsCode codes"},"magneticStripeData":{"type":"object","properties":{"track1Data":{"maxLength":76,"type":"string","description":"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"},"track2Data":{"maxLength":19,"type":"string","description":"Note: For a CardPresent scenario, MagneticStripeData.track1Data (or MagneticStripeData.track2Data) must be included."}}},"pointOfServiceData":{"required":["motoECIIndicator","panEntryMode","posConditionCode"],"type":"object","properties":{"panEntryMode":{"type":"integer","description":"A 2-digit code that identifies the method used to enter the cardholder account number and card expiration date. This code specifies whether the entire magnetic stripe is included in an authorization or financial request.
Refer to PAN Entry Mode Codes"},"posEnvironment":{"maxLength":1,"type":"string","description":"Conditional
This field is required to identify whether a transaction is merchant-initiated.
Refer to POS Environment Codes"},"motoECIIndicator":{"maxLength":1,"type":"string","description":"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"},"posConditionCode":{"type":"integer","description":"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.
Refer to POS Condition Codes"}},"description":"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."},"recipientFirstName":{"maxLength":35,"type":"string","description":"When present, this field contains recipient's first name"},"riskAssessmentData":{"type":"object","properties":{"scpExemptionIndicator":{"type":"string","description":"SCP Indicator. Acceptable values are true/false"},"traExemptionIndicator":{"type":"string","description":"TRA Exemption Indicator. Acceptable values are true/false"},"lowValueExemptionIndicator":{"type":"string","description":"Low Value Exemption Indicator. Acceptable values are true/false"},"delegatedAuthenticationIndicator":{"type":"string","description":"Delegated Authentication Indicator. Acceptable values are true/false"},"trustedMerchantExemptionIndicator":{"type":"string","description":"Trusted Merchant Exemption Indicator. Acceptable values are true/false"}}},"senderCurrencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Use a 3-character alpha or numeric currency code for currency of the sender.
Refer to ISO Codes"},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string","description":"If present, a valid value is required. Spaces or special characters are not allowed."},"senderAccountNumber":{"maxLength":34,"type":"string","description":"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)."},"senderMiddleInitial":{"maxLength":1,"type":"string","description":"This field contains sender's middle initial"},"recipientCountryCode":{"maxLength":3,"minLength":2,"type":"string","description":"when present, this field contains recipient's country code
Refer to ISO Codes"},"senderCardExpiryDate":{"type":"string","description":"The expiration date for the sender's Visa account number in senderPrimaryAccountNumber"},"originalTransactionId":{"type":"integer","description":"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."},"recipientMiddleInitial":{"maxLength":1,"type":"string","description":"When present, this field contains recipient's middle initial"},"visaMerchantIdentifier":{"maxLength":8,"minLength":8,"type":"string","description":"Visa Merchant Identifier assigned by Visa."},"addressVerificationData":{"type":"object","properties":{"street":{"maxLength":20,"minLength":0,"type":"string","description":"Street address for address verification"},"postalCode":{"maxLength":9,"minLength":4,"type":"string","description":"Conditional
Postal Code for address verification. For US, contains 5 or 9 digit ZIP code. This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee."}},"description":"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."},"merchantPseudoAbaNumber":{"maxLength":9,"minLength":9,"type":"string","description":"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."},"systemsTraceAuditNumber":{"type":"integer","description":"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."},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"localTransactionDateTime":{"type":"string","description":" ","format":"date-time"},"nationalReimbursementFee":{"type":"number","description":"When present, this field contains the IRF fees.","format":"double"},"pointOfServiceCapability":{"type":"object","properties":{"posTerminalType":{"type":"integer","description":"Note: Valid values if card is present include 0, 3 and 4. If card is not present, valid value is 5."},"posTerminalEntryCapability":{"type":"integer","description":"Note: Valid values if card is present include 0, 2 and 9. If card is not present, valid value is 1."}}},"retrievalReferenceNumber":{"maxLength":12,"minLength":12,"type":"string","description":"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."},"argentinaReimbursementFee":{"type":"number","description":"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.","format":"double"},"merchantVerificationValue":{"required":["mvvAcquirerAssigned","mvvVisaAssigned"],"type":"object","properties":{"mvvVisaAssigned":{"maxLength":6,"minLength":6,"type":"string","description":"Visa assigned MVV value. E.g. 0A45AF"},"mvvAcquirerAssigned":{"maxLength":4,"minLength":4,"type":"string","description":"Visa assists the acquirer in assigning the last four. E.g. 98FC"}},"description":"Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant."},"senderPrimaryAccountNumber":{"maxLength":19,"minLength":13,"type":"string","description":"The primary account number of the sender's account."},"settlementServiceIndicator":{"type":"integer","description":"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. "},"foreignExchangeFeeTransaction":{"type":"number","description":"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.","format":"double"},"recipientIdentificationNumberBusiness":{"maxLength":20,"type":"string","description":"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)\n
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"},"recipientIdentificationNumberIndividual":{"maxLength":13,"type":"string","description":"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
"},"cpsAuthorizationCharacteristicsIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"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."}}},"MultiPullFundsTransactionPostResponse-1":{"required":["statusIdentifier"],"type":"object","properties":{"networkId":{"type":"integer","description":"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."},"cvv2ResultCode":{"maxLength":1,"minLength":1,"type":"string","description":"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"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"statusIdentifier":{"type":"string"},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"merchantVerificationValue":{"maxLength":10,"minLength":10,"type":"string","description":"The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned."}}}}}}
```
## Create Push Funds Transaction
> Create Push Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/pushfundstransactions":{"post":{"tags":["Funds Transfer API"],"summary":"Create Push Funds Transaction","description":"Create Push Funds Transaction","operationId":"createPushFundsTransaction","requestBody":{"description":"Request body for creating in push funds transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushFundsTransactionPostPayload-5"}}}},"responses":{"200":{"description":"Conditional.
Push Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushFundsTransactionPostResponse-5"}}}}}}}},"components":{"schemas":{"PushFundsTransactionPostPayload-5":{"required":["acquirerCountryCode","acquiringBin","amount","businessApplicationId","cardAcceptor","localTransactionDateTime","retrievalReferenceNumber","systemsTraceAuditNumber","transactionCurrencyCode"],"properties":{"amount":{"type":"number","description":"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.","format":"double"},"pinData":{"required":["pinDataBlock","securityRelatedControlInfo"],"type":"object","properties":{"pinDataBlock":{"maxLength":8,"minLength":8,"type":"string","description":"Encrypted Personal Identification Number (PIN)\nFor a CardPresent with PIN Data scenario, this field is required.\n","format":"binary"},"securityRelatedControlInfo":{"required":["pinBlockFormatCode"],"type":"object","properties":{"zoneKeyIndex":{"maximum":99,"minimum":0,"type":"integer","description":"Zone Key Index"},"pinBlockFormatCode":{"maximum":99,"minimum":0,"type":"integer","description":"PIN Block Format code"}}}}},"vauFlag":{"maxLength":1,"type":"string","description":"If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed)"},"surcharge":{"type":"string","description":"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.","format":"double"},"senderCity":{"maxLength":25,"minLength":1,"type":"string","description":"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."},"senderName":{"maxLength":30,"minLength":2,"type":"string","description":"**Conditional**\n\nThe 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.\n\n**Important:** Please do not use this field for non-Visa transactions and for domestic Colombia transactions. Use `senderFirstName`, `senderLastName` & `senderMiddleName` instead.\n\n**Usage Guidelines:**\n- If the transaction is a funds disbursement, provide the name of merchant or government entity sending the funds\n- If the transaction is a pre-paid load or credit card bill pay and U.S. domestic, provide the cardholder's name\n\n**Recommended Format:** \nLast Name/Family Surname 1 + space + Last Name/Family Surname 2 (optional) + space + First Name + space + Middle Initial or Middle Name (optional)\n\n**Note:**\n- This field must not contain a ? (question mark) or any special characters\n- Only a valid and legal sender name must be populated in this field\n\n**Example:** Doe John A\n"},"accountType":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"secondaryId":{"maxLength":28,"type":"string","description":"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."},"acquiringBin":{"type":"number","description":"The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment."},"cardAcceptor":{"required":["address","idCode","name","terminalId"],"type":"object","properties":{"name":{"maxLength":25,"minLength":1,"type":"string","description":"
The Merchant Name field must conform to the format detailed in the Visa Direct Account Funding Transactions Processing Guide Merchant Data Standards Manual
For P2P payments, must contain the sender name.
For a funds disbursement, must contain either the name of the merchant or government entity sending the funds disbursement.
For pre-paid loads, must contain either the name of the load partner providing the reload service or the bank designated service name, if offered over bank channels.
For credit card bill payment, must contain either the name of the entity providing the credit card bill pay service or the bank designated service name, if offered over bank channels.
For standalone tip transfers, name must include word TIP.
For more details refer to the OCT Global Implementation Guide and Merchant Data Standards Manual."},"taxID":{"maxLength":35,"minLength":1,"type":"string","description":"Conditional.
This field contains the identifier of the acceptor issued by a taxation authority.
This field is conditionally required for all MasterCard transactions."},"idCode":{"maxLength":15,"minLength":1,"type":"string","description":"An identifier for the card acceptor (Visa Direct Originator). This value should be unique for each originator for whom you are sending transactions."},"address":{"required":["city","country"],"type":"object","properties":{"city":{"maxLength":13,"minLength":1,"type":"string","description":"City of the Merchant/Originator."},"state":{"maxLength":50,"type":"string","description":"Conditional.\n\nState or province of the Merchant/Originator.\n\nRequired if the cardAcceptor:address:country is \"US\" or \"CA\", for all cross border transactions when issuer is in Canada or Australia, and for all MasterCard transactions. \n\n\nNote: For \"US\" or \"CA\", this field can contain either the full name of the state or the 2 character code of the state. For rest of the countries, if applicable, the field contains the state code of a maximum 6 characters length."},"county":{"maxLength":50,"minLength":1,"type":"string","description":"Conditional.
Must be the county of the Merchant/Originator. Required if cardAcceptor:address:country is \"US\"."},"country":{"maxLength":50,"type":"string","description":"Valid inputs (US example in brackets [])
ISO country code (2 alpha) [example: \"US\"]
ISO country code (3 alpha) [example: \"USA\"]
ISO country code (3 numeric) [example: \"840\"].
Refer to ISO Codes"},"zipCode":{"maxLength":9,"minLength":1,"type":"string","description":"Conditional.\n\nZip/Postal code of the Merchant/Originator.\n\nRequired if the cardAcceptor:address:country is \"US\" or \"CA\", for all cross border transactions when issuer is in Canada or Australia, and for all MasterCard transactions. \n\n\nNote: For \"US\", \"CA\", and US territories (Puerto Rico/Guam/US Virgin Island/American Samoa/Northern Mariana Island), the maximum length of the field is 9 characters. For rest of the countries, the maximum length of the field is 8 characters."},"addressLine":{"maxLength":99,"minLength":1,"type":"string","description":"Conditional.\n\nStreet address of the Merchant/Originator.\n\nThis field is conditionally required for all cross border transactions when issuer is in Canada or Australia and for all MasterCard transactions."}}},"terminalId":{"maxLength":8,"minLength":1,"type":"string","description":"The identifier for the terminal at a card acceptor location. If sending transactions from a card not present environment, use the same value for all transactions."},"urlAddress":{"maxLength":256,"minLength":1,"type":"string","description":"Conditional.
This field contains the web address of the acceptor.
This field is conditionally required for all MasterCard transactions."},"partnerIDCode":{"maxLength":8,"minLength":1,"type":"string","description":"Conditional.
This field identifies a specific partnership agreement, generally between specific acceptors and issuers. may be used for transactions on accounts issued under co-branding agreements when one of the co-branding partners originates the transaction.
This field is conditionally required for all MasterCard transactions."},"legalBusinessName":{"maxLength":25,"minLength":1,"type":"string","description":"Conditional.\n\nAcceptor’s legal business name associated with the card acceptor identification code for OCT transactions.\n\nThis field is conditionally required for all Money Transfer OCTs and for all cross border transactions when issuer is in Canada or Australia."},"contactInformation":{"type":"object","properties":{"phoneNumber":{"maxLength":16,"minLength":1,"type":"string","description":"Conditional.
This field contains the business phone number of the acceptor, if different from the acceptor customer service phone number.
This field is conditionally required for all MasterCard transactions."},"additionalContactDetails":{"maxLength":256,"minLength":1,"type":"string","description":"Conditional.
This field contains additional information for contacting the acceptor, such as an additional phone number or a contact name.
This field is conditionally required for all MasterCard transactions."},"customerServicePhoneNumber":{"maxLength":16,"minLength":1,"type":"string","description":"Conditional.
This field contains the customer service phone number of the acceptor that should be used for transaction inquiries.
This field is conditionally required for all MasterCard transactions."}}},"paymentFacilitator":{"type":"object","properties":{"id":{"maxLength":11,"minLength":1,"type":"string","description":"Conditional.
Payment Facilitator ID or Marketplace ID (MasterCard). This field is conditionally required when a payment facilitator is involved or for all MasterCard transactions."},"name":{"maxLength":25,"minLength":1,"type":"string","description":"Payment facilitator name in OCTs. This field is conditionally required when a payment facilitator is involved."},"address":{"type":"object","properties":{"city":{"maxLength":50,"minLength":1,"type":"string","description":"City Name"},"state":{"maxLength":3,"minLength":1,"type":"string","description":"State/province Code"},"country":{"maxLength":3,"minLength":3,"type":"string","description":"Alpha Country Code"},"postalCode":{"maxLength":10,"minLength":4,"type":"string","description":"Postal code or zip code"},"streetAddress":{"maxLength":99,"minLength":1,"type":"string","description":"street Address"}}},"subMerchantId":{"maxLength":15,"minLength":1,"type":"string","description":"Conditional.
Sub-Merchant ID containing the sponsored merchant ID. This field is conditionally required when a payment facilitator is involved or for all MasterCard transactions."},"independentSalesOrganizationID":{"maxLength":11,"minLength":1,"type":"string","description":"Conditional.
This field contains the \"Company ID\" that is assigned during the time of registration with Mastercard Connect as a service provider and must be provided by the acquirer.
This field is conditionally required for all MasterCard transactions."}}},"serviceLocationDetails":{"type":"object","properties":{"address":{"required":["country"],"type":"object","properties":{"city":{"maxLength":50,"minLength":1,"type":"string","description":"Conditional.\n\nThis field contains the name of the city where the cardholder received the services.\n\nThis field is conditionally required for all MasterCard transactions."},"state":{"maxLength":3,"minLength":1,"type":"string","description":"Conditional.\n\nThis field contains the ISO code of the State/Province or country subdivision where the cardholder received the services.\n\nThis field is conditionally required for all MasterCard transactions."},"postalCode":{"maxLength":10,"minLength":1,"type":"string","description":"Conditional.
This field contains the postal code of the country where the cardholder received the services.\n\nThis field is conditionally required for all MasterCard transactions."},"countryCode":{"maxLength":3,"minLength":3,"type":"string","description":"Conditional.\n\nThis field contains the 3 character alpha ISO country code of the country where the cardholder received the services. \n\nThis field is conditionally required for all MasterCard transactions.
Refer to ISO Codes"}}}}}}},"sourceAmount":{"type":"number","description":"**Conditional**\n\nSource 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.\n","format":"double"},"cardCvv2Value":{"maxLength":4,"minLength":3,"type":"string","description":"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)"},"recipientCity":{"maxLength":25,"type":"string","description":"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"},"recipientName":{"maxLength":30,"minLength":1,"type":"string","description":"**Conditional**\n\nThe 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. \n\nPlease do not use this field for non-Visa transactions and for domestic Colombia transactions. Use `recipientFirstName`, `recipientLastName` & `recipientMiddleName` instead.\n\nThis field contains the recipient's name and is required for cross-border enhanced money transfer done with Visa cards.\n\n**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)\n\n**Note:**-\n- This field must not contain a ? (question mark) or any special characters\n- Only a valid and legal recipient name must be populated in this field. \n**Example:** Doe John A\n"},"senderAddress":{"maxLength":35,"minLength":1,"type":"string","description":"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"},"recipientState":{"maxLength":3,"type":"string","description":"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"},"senderLastName":{"maxLength":35,"minLength":2,"type":"string","description":"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"},"senderFirstName":{"maxLength":35,"minLength":2,"type":"string","description":"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"},"senderReference":{"maxLength":16,"type":"string","description":"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."},"senderStateCode":{"maxLength":2,"minLength":2,"type":"string","description":"Conditional.
Required if senderCountryCode is either 124(CAN) or 840(USA)
Note:
This field is not applicable for domestic Colombia transactions"},"purposeOfPayment":{"maxLength":12,"minLength":1,"type":"string","description":"**Conditional**\n\nThis 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.\n\n- For India, Bangladesh, Egypt and Argentina: Purpose of payment is mandatory for all BAIs except CO, CI and MP\n- For Chile: Purpose of payment is mandatory for BAI-FD \n- For Colombia: Purpose of payment is mandatory for BAI-AA and PP\n"},"schemeIdentifier":{"maxLength":2,"minLength":2,"pattern":"^[a-zA-Z0-9]{2}$","type":"string","description":"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."},"senderEntityType":{"maxLength":1,"minLength":1,"type":"string","description":"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."},"senderMiddleName":{"maxLength":35,"minLength":1,"type":"string","description":"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"},"senderOccupation":{"maxLength":35,"minLength":1,"type":"string","description":"Account Owner Occupation. Only alpha-numeric data is accepted"},"senderPostalCode":{"maxLength":10,"minLength":5,"type":"string","description":"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."},"senderStreetName":{"maxLength":99,"type":"string","description":"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."},"sharingGroupCode":{"maxLength":30,"type":"string","description":"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."},"customerReference":{"maxLength":17,"minLength":1,"type":"string","description":"Conditional.
This field contains a value that identifies the customer.
This field needs to be populated for Argentina domestic transaction where businessApplicationId is \"PS\"."},"messageReasonCode":{"type":"number","description":"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."},"recipientLastName":{"maxLength":35,"minLength":1,"type":"string","description":"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"},"senderCountryCode":{"maxLength":3,"minLength":3,"type":"string","description":"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"},"senderDateOfBirth":{"type":"string","description":"This field contains the birth date for the sender.
Format: YYYY-MM-DD
Example: 2011-12-30","format":"date"},"senderNationality":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of nationality in alphabets."},"sourceOfFundsCode":{"maxLength":2,"minLength":2,"type":"string","description":"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"},"cardSequenceNumber":{"maximum":999,"minimum":0,"type":"integer","description":"Card Sequence Number"},"magneticStripeData":{"$ref":"#/components/schemas/MagneticStripeDataV2V2"},"pointOfServiceData":{"type":"object","properties":{"panEntryMode":{"type":"number","description":"Required for Card Present Transfer\n\nA 2-digit code that identifies the method used to enter the cardholder account number and card expiration date. This code specifies whether the entire magnetic stripe is included in an authorization or financial request.\n\nRecommended value for card/token verification for Card not present transactions is 01. Default value is 01.\n\nRefer to PAN Entry Mode Codes (https://developer.visa.com/request_response_codes#pan_entry_mode_codes) \n"},"motoECIIndicator":{"maximum":8,"minimum":1,"type":"number","description":"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 Visa 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.\nIf not provided, Visa will default its value to 7\n"},"posConditionCode":{"type":"number","description":"Required for Card Present Transfer\n\nContains 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.\n\nRecommended value for Address/cvv2/account verification without authorization is 59. Default value is 59.\n\nRefer to POS Condition Codes (https://developer.visa.com/request_response_codes#pos_cond_code_codes) \n"},"specialConditionIndicatorMerchant":{"maxLength":1,"minLength":1,"type":"string","description":"1 - Purchase of Central Bank Digital Currency (CBDC) or Tokenized Deposits
\n2 - Purchase of Stablecoin (fiat-backed)
\n3 - Purchase of Blockchain Native Token/Coin
\n7 - Purchase of Cryptocurrency\n"}},"description":"Conditional\n\nRequired for Card Present Transfer\n\nContains 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.\nNote: For a CardPresent or Token Transactions, this field is required. \nIf this Object is not passed in the request then API will default at following values: \n\"pointOfServiceData\": { \"panEntryMode\": \"01\",\"posConditionCode\": \"59\",\"motoECIIndicator\":\"7\"}\"\n"},"purchaseIdentifier":{"required":["referenceNumber","type"],"type":"object","properties":{"type":{"maxLength":1,"type":"string","description":"This field should be populated with one of the following values:
1 - Order Number
6 - if referenceNumber is a Visa Direct Request to Pay ID. businessApplicationId may be either PP (C2C OCT payment) or RP (C2B OCT payment) where the payer is initiating the OCT to the payer in response to a Request to Pay."},"referenceNumber":{"maxLength":25,"minLength":25,"type":"string","description":"Populate this field with the reference identifier for which the payment is being sent. For example, a request to pay ID or other unique ID related to this payment.
This field will carry R2P ID/RTX generated request ID for BP and RP BAI. It will be used for C2B use case in the CEMEA region where payee initiates the OCT to the payer."}},"description":"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."},"recipientFirstName":{"maxLength":35,"minLength":1,"type":"string","description":"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"},"senderAddressLine1":{"maxLength":99,"type":"string","description":"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."},"senderAddressLine2":{"maxLength":99,"type":"string","description":"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."},"sourceCurrencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"**Conditional**\n\n3-character alpha or numeric currency code for currency of the sourceAmount field.\n\nRefer to [ISO Codes](/request_response_codes#iso_country_and_currency_codes)\n"},"acquirerCountryCode":{"type":"number","description":"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"},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string","description":"Note: If present, a valid value is required. Spaces or special characters are not allowed."},"recipientEntityType":{"maxLength":1,"minLength":1,"type":"string","description":"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."},"recipientMiddleName":{"maxLength":35,"minLength":1,"type":"string","description":"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"},"recipientOccupation":{"maxLength":35,"minLength":1,"type":"string","description":"Account Owner Occupation. Only alpha-numeric data is accepted"},"recipientPostalCode":{"maxLength":16,"type":"string","description":"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."},"recipientStreetName":{"maxLength":99,"type":"string","description":"This field contains the street name of the recipient address.
Maps to the following ISO 8583 field
- Field 56, Tag 88"},"senderAccountNumber":{"maxLength":19,"minLength":13,"type":"string","description":"**Conditional**\n\nIf 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.\n\n**Note:** This is a 16-digit PAN or token which defines the account of the consumer (sender of push payment).\n\n**Note:** PAN or a network token must not be used if Payment Credential Reference is used to send sender's PCI Token Reference ID.\n\nOnly one of 'senderAccountNumber' and 'senderPaymentCredentialReference' is provided in a request\n"},"senderLocalNameData":{"required":["dataEncodingFormat","languageCode"],"type":"object","properties":{"lastName":{"maxLength":35,"minLength":1,"type":"string","description":"Sender's lastname name in local language."},"aliasName":{"maxLength":70,"minLength":1,"type":"string","description":"Sender's alias name in local language."},"firstName":{"maxLength":35,"minLength":1,"type":"string","description":"Sender's first name in local language."},"middleName":{"maxLength":35,"minLength":1,"type":"string","description":"Sender's middle name in local language."},"languageCode":{"maxLength":3,"minLength":3,"type":"string","description":"3 characters ISO 639 language code. Example 'heb' for Hebrew."},"dataEncodingFormat":{"maxLength":2,"minLength":2,"type":"string","description":"01 = UTF-8"}},"description":"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."},"senderMiddleInitial":{"maxLength":1,"minLength":1,"type":"string","description":"This field contains sender's middle initial.
Note:
This field is not applicable for domestic Colombia transactions."},"merchantCategoryCode":{"type":"number","description":"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"},"recipientCountryCode":{"maxLength":3,"minLength":3,"type":"string","description":"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."},"recipientDateOfBirth":{"pattern":"\\d\\d\\d\\d\\-\\d\\d\\-\\d\\d","type":"string","description":"Account Owner Date of Birth.(format YYYY-MM-DD)","format":"date"},"recipientNationality":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of nationality in alphabets."},"senderAdditionalData":{"type":"object","properties":{"identificationList":{"type":"array","description":"Identification list of sender.
For domestic Colombia and Ukraine transactions, we will send all the instances of ID information received to the issuer.
For other transactions, we have a current limitation that sender ID and recipient ID information are mutually exclusive. If both sender ID and recipient ID are sent in the same request, only sender ID related information will be sent to the issuer. Additionally, only 1 instance of ID per sender or recipient is currently supported. If more than one instance is provided, only the first instance will be forwarded to the issuer.","items":{"type":"object","properties":{"idType":{"maxLength":4,"minLength":1,"type":"string","description":"This field will contain the type of sender identification. The valid values are: The valid values are: CUID - Customer identification - unspecified NTID - National identification PASN - Passport number DRLN - Driver license TXIN - Tax identification CPNY - Company registration number PRXY - Proxy identification SSNB - Social security number ARNB - Alien registration number LAWE - Law enforcement identification MILI - Military identification TRVL - Travel identification - non-passport EMAL - Email PHON - Phone number BTHD - Date of Birth For a given instance of identificationList[], a minimum of idType and idNumber fields should be provided, else the ID information will not be forwarded to the issuer.","enum":["CUID","NTID","PASN","DRLN","TXIN","CPNY","PRXY","SSNB","ARNB","LAWE","MILI","TRVL","EMAL","PHON","BTHD"]},"idNumber":{"maxLength":35,"minLength":1,"type":"string","description":"This field will contain an acquirer-populated value associated with the Identification Type in field idType When idType contains the value of BTHD (Date of birth), this tag must contain a date of birth in ccyymmdd format where: cc = century, yy = year, mm = month, dd = day. For a given instance of identificationList[] , a minimum of idType and idNumber fields should be provided, else the ID information will dropped and not be forwarded to the issuer."},"idOwnerType":{"maxLength":1,"minLength":1,"type":"string","description":"This field denotes whether the Tax ID is a business or individual's Tax ID when idType contains the value of TXIN (Tax identification).\nThe valid values are : \nB (Business) \nI (Individual)"},"idIssueCountry":{"maxLength":3,"minLength":3,"type":"string","description":"This tag will contain the 3-alpha or 3-digit ISO country code of the ID issuing country."}}}},"ancillarySenderDetails":{"type":"array","description":"Ancillary sender details.
Note This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"maxLength":25,"type":"string","description":"This field contains the city of the ancillary sender's address."},"postalCode":{"maxLength":16,"type":"string","description":"This field contains the postal code of the ancillary sender's address."},"streetName":{"maxLength":99,"type":"string","description":"This field contains the street name of the ancillary sender's address."},"countryCode":{"maxLength":16,"type":"string","description":"This field contains the 3 char alpha ISO country code of the ancillary sender's address.
Refer to ISO Codes"},"addressLine1":{"maxLength":99,"type":"string","description":"This field contains the first line of the ancillary sender's address."},"addressLine2":{"maxLength":99,"type":"string","description":"This field contains the second line of the ancillary sender's address."},"buildingNumber":{"maxLength":16,"type":"string","description":"This field contains the building number or house number of the ancillary sender's address."}}},"lastName":{"maxLength":35,"type":"string","description":"This field contains ancillary sender's last name"},"firstName":{"maxLength":35,"type":"string","description":"This field contains ancillary sender's first name"},"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the ancillary sender is for a business or an individual. The valid value are 'B' for Business and 'I' for Individual."},"middleName":{"maxLength":35,"type":"string","description":"This field contains ancillary sender's middle name"}}}},"contactInformationList":{"type":"array","description":"Contact Information list of sender.
Note- This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the contact information is for a business or an individual. The valid value are 'B' for Business and 'I' for Individual."},"contactType":{"type":"string","description":"This field identifies the type of contact information. The valid value is \"PHONE\" for phone number.\n\n**Note:** For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer.\n"},"contactValue":{"maxLength":16,"type":"string","description":"This field contains the contact value for provided contact type.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."}}}}}},"senderBuildingNumber":{"maxLength":16,"type":"string","description":"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."},"senderCountryOfBirth":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of birth in alphabets"},"businessApplicationId":{"maxLength":2,"minLength":2,"type":"string","description":"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"},"recipientAddressLine1":{"maxLength":99,"type":"string","description":"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"},"recipientAddressLine2":{"maxLength":99,"type":"string","description":"Optional.
This field contains the second line of the recipient address."},"serviceProcessingType":{"required":["requestType"],"type":"object","properties":{"requestType":{"maxLength":2,"minLength":2,"type":"string","description":"00: (Not a deferred OCT). This value indicates that the request is not a deferred OCT. Visa will send this value to the recipient issuer in the request. This acts as the default value if not provided in the request.
01: (Originator hold). This value indicates that the originating acquirer has held the OCT for a period of time before sending to Visa and is requesting for Visa to treat the transaction as a deferred OCT. Visa will send this value to the recipient issuer in the request.Note: The value of 01 is reserved for originating acquirers that meet certain conditions. Contact your regional client support representative for more information.02: (Visa deferred OCT hold, default interval).This value indicates that the originating acquirer is requesting Visa to apply the default holding period of 48 hours upon receipt and process the request as a deferred OCT. Visa will send this value to the recipient issuer in the request.03: (Visa deferred OCT hold, client defined interval).This value indicates that the originating acquirer is requesting Visa to apply the client defined holding period (provided in deferredDateTime field) upon receipt and process the request as a deferred OCT. Visa will send this value to the recipient issuer in the request."},"deferredDateTime":{"maxLength":12,"minLength":12,"type":"string","description":"This field is conditionally required for requestType 03. This field identifies when the transaction needs to be processed by Visa. Format of this value will be in CCYYMMDDHHMM (GMT). The provided deferredDateTime should be within 24 to 48 hours of receipt of the request by Visa."}},"description":"This field will contain values that identify the type of service the transaction should be processed."},"transactionIdentifier":{"type":"number","description":"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.","format":"int64"},"recipientLocalNameData":{"required":["dataEncodingFormat","languageCode"],"type":"object","properties":{"lastName":{"maxLength":35,"minLength":1,"type":"string","description":"Recipient's lastname name in local language."},"aliasName":{"maxLength":70,"minLength":1,"type":"string","description":"Recipient's alias name in local language."},"firstName":{"maxLength":35,"minLength":1,"type":"string","description":"Recipient's first name in local language."},"middleName":{"maxLength":35,"minLength":1,"type":"string","description":"Recipient's middle name in local language."},"languageCode":{"maxLength":3,"minLength":3,"type":"string","description":"3 characters ISO 639 language code. Example 'heb' for Hebrew."},"dataEncodingFormat":{"maxLength":2,"minLength":2,"type":"string","description":"01 = UTF-8"}},"description":"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."},"recipientMiddleInitial":{"maxLength":1,"minLength":1,"type":"string","description":"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)"},"visaMerchantIdentifier":{"maxLength":8,"minLength":8,"type":"string","description":"Visa Merchant Identifier assigned by Visa.
Note: For BAI as MI, either this field or cardAcceptor.paymentFacilitator.id or both should be present."},"merchantPseudoAbaNumber":{"maxLength":9,"type":"string","description":"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."},"recipientAdditionalData":{"type":"object","properties":{"identificationList":{"type":"array","description":"Identification list of recipient.
For domestic Colombia and Ukraine transactions, we will send all the instances of ID information received to the issuer.
For other transactions, we have a current limitation that sender ID and recipient ID information are mutually exclusive. If both sender ID and recipient ID are sent in the same request, only sender ID related information will be sent to the issuer. Additionally, only 1 instance of ID per sender or recipient is currently supported. If more than one instance is provided, only the first instance will be forwarded to the issuer.","items":{"type":"object","properties":{"idType":{"maxLength":4,"minLength":1,"type":"string","description":"This field will contain the type of reciepint identification. The valid values are: CUID - Customer identification - unspecified NTID - National identification PASN - Passport number DRLN - Driver license TXIN - Tax identification CPNY - Company registration number PRXY - Proxy identification SSNB - Social security number ARNB - Alien registration number LAWE - Law enforcement identification MILI - Military identification TRVL - Travel identification - non-passport EMAL - Email PHON - Phone number BTHD - Date of Birth For a given instance of identificationList[], a minimum of idType and idNumber fields should be provided, else the ID information will not be forwarded to the issuer.","enum":["CUID","NTID","PASN","DRLN","TXIN","CPNY","PRXY","SSNB","ARNB","LAWE","MILI","TRVL","EMAL","PHON","BTHD"]},"idNumber":{"maxLength":35,"minLength":1,"type":"string","description":"This field will contain an acquirer-populated value associated with the Identification Type in field idType.
When idType contains the value of BTHD (Date of birth), this tag must contain a date of birth in ccyymmdd format where cc = century, yy = year, mm = month, dd = day. For a given instance of identificationList[], a minimum of idType and idNumber fields should be provided, else the ID information will be dropped and not forwarded to the issuer."},"idOwnerType":{"maxLength":1,"minLength":1,"type":"string","description":"This field denotes whether the Tax ID is a business or individual's Tax ID when idType contains the value of TXIN (Tax identification).\nThe valid values are : \nB (Business) \nI (Individual)"},"idIssueCountry":{"maxLength":3,"minLength":3,"type":"string","description":"This tag will contain the 3-alpha or 3-digit ISO country code of the ID issuing country."}}}},"contactInformationList":{"type":"array","description":"Contact Information list of recipient.
Note- This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the contact information is for a business or an individual. The valid value are 'B' for Business and 'I' for Individual."},"contactType":{"type":"string","description":"This field identifies the type of contact information. The valid value is \"PHONE\" for phone number.\n\n**Note:** For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer.\n"},"contactValue":{"maxLength":16,"type":"string","description":"This field contains the contact value for provided contact type.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."}}}},"ancillaryRecipientDetails":{"type":"array","description":"Ancillary recipient details.
Note This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"maxLength":25,"type":"string","description":"This field contains the city of the ancillary recipient's address."},"postalCode":{"maxLength":16,"type":"string","description":"This field contains the postal code of the ancillary recipient's address."},"streetName":{"maxLength":99,"type":"string","description":"This field contains the street name of the ancillary recipient's address."},"countryCode":{"maxLength":16,"type":"string","description":"This field contains the 3 char alpha ISO country code of the ancillary recipient's address.
Refer to ISO Codes"},"addressLine1":{"maxLength":99,"type":"string","description":"This field contains the first line of the ancillary recipient's address."},"addressLine2":{"maxLength":99,"type":"string","description":"This field contains the second line of the ancillary recipient's address."},"buildingNumber":{"maxLength":16,"type":"string","description":"This field contains the building number or house number of the ancillary recipient's address."}}},"lastName":{"maxLength":35,"type":"string","description":"This field contains ancillary recipient's last name"},"firstName":{"maxLength":35,"type":"string","description":"This field contains ancillary recipient's first name"},"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the ancillary recipient is for a business or an individual. The valid value are 'B' for Business and 'I' for Individual."},"middleName":{"maxLength":35,"type":"string","description":"This field contains ancillary recipient's middle name"}}}}}},"recipientBuildingNumber":{"maxLength":16,"type":"string","description":"Optional.
This field contains the house or building number of the recipient address."},"recipientCardExpiryDate":{"type":"string","description":"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","format":"date"},"recipientCountryOfBirth":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of birth in alphabets"},"systemsTraceAuditNumber":{"type":"number","description":"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."},"transactionCurrencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"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 "},"additionalPOSInformation":{"$ref":"#/components/schemas/AdditionalPOSInformation"},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"localTransactionDateTime":{"type":"string","description":"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","format":"date-time"},"nationalReimbursementFee":{"type":"number","description":"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.","format":"double"},"pointOfServiceCapability":{"required":["posTerminalEntryCapability","posTerminalType"],"type":"object","properties":{"posTerminalType":{"maximum":9,"minimum":0,"type":"integer","description":"Basic POS electronic terminal category\n\nRecommended value for card not present is 0. Default value is 0.\n\nNote:Valid values if card is present include 0, 3 and 4. If card is not present, valid value is 0. \n"},"posTerminalEntryCapability":{"maximum":9,"minimum":0,"type":"integer","description":"1-digit code identifies the capability of the terminal to electronically read account numbers (and expiration dates) from cards. \n"},"acceptsPartialAuthorizations":{"maximum":9,"minimum":0,"type":"integer","description":"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."}},"description":"Conditional\n\nNote: For a CardPresent Transactions, this field is required.\n\nIf this object is not present API will default following values \"pointOfServiceCapability\": {\"posTerminalType\": \"0\",\"posTerminalEntryCapability\": \"1\",\"acceptsPartialAuthorizations\":\"false\"}\" \n"},"retrievalReferenceNumber":{"maxLength":12,"minLength":12,"type":"string","description":"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."},"integratedCircuitCardData":{"$ref":"#/components/schemas/IntegratedCircuitCardDataV2V2"},"merchantVerificationValue":{"required":["mvvAcquirerAssigned","mvvVisaAssigned"],"type":"object","properties":{"mvvVisaAssigned":{"maxLength":6,"minLength":6,"type":"string","description":"Visa assigned MVV value. E.g. 0A45AF"},"mvvAcquirerAssigned":{"maxLength":4,"minLength":4,"type":"string","description":"Visa assists the acquirer in assigning the last four. E.g. 98FC"}},"description":"Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant."},"mexicoNationalServiceData":{"required":["reimbursementFee","reimbursementFeeTax"],"type":"object","properties":{"irfType":{"maxLength":1,"minLength":1,"type":"string","description":"This field contains one of the following values:
0 - Unknown/default
1 - Fixed
2 - Ad valorem (%)
3 - Composite (fixed amount and ad valorem)"},"accountType":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains one of the following values:
CO - Commercial products
CR - Credit
DB - Debit
PL - Private label
PP - Prepaid"},"irfCategoryCode":{"maxLength":2,"minLength":1,"type":"string","description":"This field optionally contains any value from 00 to 99."},"merchantFiscalId":{"maxLength":13,"type":"string","description":"This field contains RFC for the merchant. This is an alphanumeric field. The RFC format can be AAAANNNNNNAAA, where A is alphanumeric value and N is a numeric value."},"reimbursementFee":{"type":"number","description":"This field contains the Client-Calculated Interchange Reimbursement Fee in the same currency as the transaction. It must not contain zeros.","format":"double"},"reimbursementFeeTax":{"type":"number","description":"This field contains the VAT calculated for the IRF applicable to the transaction. It must not contain zeros.","format":"double"}},"description":"Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement."},"senderPersonalEmailAddress":{"maxLength":99,"minLength":1,"type":"string","description":"Account owner email address."},"settlementServiceIndicator":{"maximum":9,"minimum":0,"type":"number","description":"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. "},"colombiaNationalServiceData":{"required":["countryCodeNationalService","nationalNetReimbursementFeeBaseAmount"],"type":"object","properties":{"addValueTaxAmount":{"type":"number","description":"This is the national government tax for added value of good or service.
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.","format":"double"},"addValueTaxReturn":{"type":"number","description":"This is base value of the IVA (Sales tax). Optional. This field indicates base value of the IVA ( Sales tax which is part of the benefit of the tax legislations for the 2% sale tax return to the cardholder.
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.","format":"double"},"taxAmountConsumption":{"type":"number","description":"This is the national consumption tax amount.
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.","format":"double"},"nationalNetMiscAmount":{"type":"number","description":"This is an amount field that contains an airport charge, cashback or a tip.
Format:
Minimum Value: 0
Maximum value: 999999999.999
Allowed fractional digits: 3","format":"double"},"emvTransactionIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"Contains one of the below valid values:
0 - Does not apply to EMV
1 - EMV transaction
2 - Fallback transaction"},"costTransactionIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"Contains one of the below valid values:
0 - Not a cost inquiry amount
1 - Cost inquiry transaction"},"nationalChargebackReason":{"type":"number","description":"Contains a domestic chargeback reason code."},"nationalReimbursementFee":{"type":"number","description":"Numeric entry indicating a fee for a National Settlement transaction. It must be zeros unless the transaction is a National Settlement transaction for a country using this capability. Two decimal positions are implied.","format":"double"},"nationalNetMiscAmountType":{"maxLength":1,"minLength":1,"type":"string","description":"It identifies the type of the miscellaneous amount – i.e. whether it is one of:
A - Airport charge
C - Cashback
T - Tip
Must be one of the above valid values if nationalNetMiscAmount > 0.
Must be skipped if nationalNetMiscAmount = 0."},"countryCodeNationalService":{"type":"number","description":"The acquirer's country code. Must be 170 for Colombia."},"nationalNetReimbursementFeeBaseAmount":{"type":"number","description":"The client supplied interchange reimbursement amount expressed in the transaction currency. This must be less than the transaction amount.
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.","format":"double"}},"description":"Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement"},"argentinaNationalServiceData":{"required":["reimbursementFee"],"type":"object","properties":{"reimbursementFee":{"type":"number","description":"This field contains the Argentina member supplied reimbursement fee. It should be set to 0 for Argentina Domestic Purchase transactions.","format":"double"},"reimbursementFeeTax":{"type":"number","description":"Conditional.
This field contains the VAT calculated for the IRF applicable to the transaction.","format":"double"}},"description":"Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement."},"recipientPersonalEmailAddress":{"maxLength":99,"minLength":1,"type":"string","description":"Account owner email address."},"recipientPrimaryAccountNumber":{"maxLength":19,"minLength":13,"type":"string","description":"This is a 16-digit PAN or token for the account of the recipient of push payment.\nConditional Only one of 'recipientPrimaryAccountNumber' and 'recipientPaymentCredentialReference' is provided in a request"},"recipientSubDivisionMinorCode":{"maxLength":16,"type":"string","description":"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."},"senderPaymentCredentialReference":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["PCI_TOKEN_REFID"]},"value":{"maxLength":75,"minLength":1,"type":"string"},"merchantId":{"maxLength":50,"minLength":1,"type":"string","description":"Conditional
Unique Merchant Identification assigned by Token Service Provider."}},"description":"Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID\n\nConditional\nOnly one of 'senderAccountNumber' and 'senderPaymentCredentialReference' is provided in a request\n"},"masterCardMerchantPaymentGatewayId":{"maxLength":11,"minLength":1,"type":"string","description":"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."},"senderIdentificationNumberBusiness":{"maxLength":20,"minLength":1,"type":"string","description":"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."},"recipientPaymentCredentialReference":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["PCI_TOKEN_REFID","PAYNAME"]},"value":{"maxLength":75,"minLength":1,"type":"string","description":"If type is PAYNAME then length should be between 6 and 50 characters.
Format should be +payname.domain. The payname, between '+' and '.' characters, should be minimum 3 characters."},"merchantId":{"maxLength":50,"minLength":1,"type":"string","description":"Conditional
Unique Merchant Identification assigned by Token Service Provider. Only required if type is PCI_TOKEN_REFID."}},"description":"Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID or Visa+ Payname.\n\nConditional\nOnly one of 'recipientPrimaryAccountNumber' and 'recipientPaymentCredentialReference' is provided in a request.\n"},"senderIdentificationNumberIndividual":{"maxLength":13,"minLength":1,"type":"string","description":"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."}}},"MagneticStripeDataV2V2":{"oneOf":[{"$ref":"#/components/schemas/Track1Data"},{"$ref":"#/components/schemas/Track2Data"}]},"Track1Data":{"required":["track1Data"],"type":"object","properties":{"track1Data":{"maxLength":76,"type":"string","description":"Conditional\n\nNote: For a cardPresent scenario, magneticStripeData.track1Data (or magneticStripeData.track2Data) must be included.\n\nNote: These fields are only available in OCT transactions in specific geographies. Please reach out to your Visa representative for details\n"}}},"Track2Data":{"required":["track2Data"],"type":"object","properties":{"track2Data":{"maxLength":19,"type":"string","description":"Conditional\n\nNote: For a CardPresent scenario, MagneticStripeData.track1Data (or MagneticStripeData.track2Data) must be included.\n","format":"binary"}}},"AdditionalPOSInformation":{"type":"object","properties":{"chipConditionCode":{"maximum":9,"minimum":0,"type":"integer","description":"This field applies to magnetic stripe read transactions where the card and terminal are chip capable.\nThe 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.\n
Valid values include:\n
\n
0 - Not applicable to fallback transactions. For chip read transactions this field must contain a 0 or be excluded from the message.\n
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.\n
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.\n \n"},"chipTransactionIndicator":{"maximum":9,"minimum":0,"type":"integer","description":"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. \n"},"chipAuthenticationReliabilityIndicator":{"maximum":9,"minimum":0,"type":"integer","description":"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.\n"}}},"IntegratedCircuitCardDataV2V2":{"maxLength":510,"minLength":2,"type":"string","description":"A blob containing the Chip card data in TLV format."},"PushFundsTransactionPostResponse-5":{"required":["actionCode","responseCode","transactionIdentifier","transmissionDateTime"],"properties":{"networkId":{"type":"number","description":"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."},"tokenData":{"type":"object","properties":{"tokenAssuranceMethod":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains different category value to determine the Risk Score associated with the token and transaction."}},"description":"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."},"actionCode":{"maxLength":2,"minLength":2,"type":"string","description":"The results of the transaction request
Refer to action code
Note: : The VisaNet Response Code for the transaction"},"last4ofPAN":{"maxLength":4,"minLength":4,"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"maxLength":6,"type":"string","description":"The authorization code from the issuer."},"persistentFX":{"type":"object","properties":{"exchangeRate":{"type":"number","description":"PFX Exchange Rate decimal","format":"bigDecimal"},"visaRateTableId":{"maxLength":5,"minLength":1,"type":"string","description":"Rate table Id of the PFX exchange rate"},"visaRateProvider":{"maxLength":70,"minLength":1,"type":"string","description":"Provider of the PFX exchange rate"}}},"responseCode":{"maxLength":1,"type":"string","description":"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"},"cvv2ResultCode":{"maxLength":1,"minLength":1,"type":"string","description":"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"},"prepaidBalance":{"type":"string","description":"Min Inclusive: -999999999.999
Max Inclusive: 999999999.999
Note: Applicable only for Top Up Transactions"},"settlementInfo":{"type":"object","properties":{"settlementAmount":{"type":"number","description":"Transaction amount converted in settlement currency","format":"bigDecimal"},"settlementCurrencyCode":{"type":"integer","description":"Settlement Currency code"},"settlementConversionRate":{"type":"number","description":"Exchange Rate used to convert the transaction amount to settlement amount in case of multi-currency
Note:
get the value in decimal values by combining rate value with rate decimal positions","format":"bigDecimal"}},"description":"get the value in decimal values by combining rate value with rate decimal positions"},"settlementFlags":{"required":["settlementResponsibilityFlag"],"type":"object","properties":{"givUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementServiceFlag":{"maxLength":1,"minLength":1,"type":"string","description":"Possible values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement
"},"givPreviouslyUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementResponsibilityFlag":{"type":"string","description":"Possible values are true or false"}},"description":""},"statusIdentifier":{"type":"string","description":"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."},"originalActionCode":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"responseReasonCode":{"maxLength":4,"minLength":1,"type":"string","description":"This field contains the merchant advice code value received from Mastercard authorization response messages."},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string"},"transmissionDateTime":{"type":"string","description":"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","format":"date-time"},"serviceProcessingType":{"required":["requestType"],"type":"object","properties":{"requestType":{"maxLength":2,"minLength":2,"type":"string","description":"00: (Not a deferred OCT). This value indicates that the request is not a deferred OCT. Visa will send this value to the recipient issuer in the request. This acts as the default value if not provided in the request.01: (Originator hold). This value indicates that the originating acquirer has held the OCT for a period of time before sending to Visa and is requesting for Visa to treat the transaction as a deferred OCT. Visa will send this value to the recipient issuer in the request.Note: The value of 01 is reserved for originating acquirers that meet certain conditions. Contact your regional client support representative for more information.02: (Visa deferred OCT hold, default interval).This value indicates that the originating acquirer is requesting Visa to apply the default holding period of 48 hours upon receipt and process the request as a deferred OCT. Visa will send this value to the recipient issuer in the request.03: (Visa deferred OCT hold, client defined interval).This value indicates that the originating acquirer is requesting Visa to apply the client defined holding period (provided in deferredDateTime field) upon receipt and process the request as a deferred OCT. Visa will send this value to the recipient issuer in the request."},"deferredDateTime":{"maxLength":12,"minLength":12,"type":"string","description":"If exist, identifies when the transaction will be processed by Visa. Format of this value will be in CCYYMMDDHHMM.CC - Current CenturyYY - YearMM - MonthDD - dateHH - HourMM - Minute"}},"description":"This field will contain values that identifies the type of service assigned for the transaction."},"transactionIdentifier":{"type":"number","description":"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.","format":"int64"},"prepaidBalanceCurrency":{"maxLength":3,"minLength":3,"type":"string","description":"Refer to ISO Codes"},"additionalTokenRespInfo":{"maxLength":1,"minLength":1,"type":"string","description":"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."},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"retrievalReferenceNumber":{"maxLength":12,"minLength":12,"type":"string","description":"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."},"vauRTAuthReplacementData":{"type":"object","properties":{"vauFlag":{"maxLength":1,"minLength":1,"type":"string","description":"Possible values are : Y (replacement occurred). N (No replacements)"},"vauAccntStatus":{"maxLength":1,"minLength":1,"type":"string","description":"Indicates C (closed account) or Q (contact cardholder)"},"replacementCardID":{"maxLength":28,"minLength":1,"type":"string","description":"The replacement pan, if it exists"},"vauErrorReasonCode":{"maxLength":6,"minLength":6,"type":"string","description":"Conditional. If present, describes the reason the VAU failed"},"replaceDateExpiration":{"maxLength":7,"minLength":7,"type":"string","description":"Replacement pan expiration date, if it exists. This is returned even if the expiration date was not passed in the request.
Format: YYYY-MM"}}},"cardAuthenticationResults":{"maxLength":1,"minLength":1,"type":"string","description":"A Visa-defined code indicating Online Card Authentication Method results.\nRefer to cardAuthenticationResults (https://developer.visa.com/request_response_codes#cardAuthenticationResults)\n"},"integratedCircuitCardData":{"$ref":"#/components/schemas/IntegratedCircuitCardDataV2V2"},"merchantVerificationValue":{"maxLength":10,"minLength":10,"type":"string","description":"The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned."},"transactionLinkIdentifier":{"maxLength":36,"minLength":1,"type":"string","description":"Transaction Link Identifier returned from other networks like MasterCard and Pulse"}}}}}}
```
## Create Multi Reverse Funds Transaction
> Create Multi Reverse Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/multireversefundstransactions":{"post":{"tags":["Funds Transfer API"],"summary":"Create Multi Reverse Funds Transaction","description":"Create Multi Reverse Funds Transaction","operationId":"createMultiReverseFundsTransaction","requestBody":{"description":"Request body for creating in multi reverse funds transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiReverseFundsTransactionPostPayload-3"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiReverseFundsTransactionPostPayload-3"}}},"required":true},"responses":{"200":{"description":"Multi Reverse Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiReverseFundsTransactionPostResponse-3"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiReverseFundsTransactionPostResponse-3"}}}}}}}},"components":{"schemas":{"MultiReverseFundsTransactionPostPayload-3":{"required":["acquirerCountryCode","acquiringBin","localTransactionDateTime","request"],"type":"object","properties":{"request":{"type":"array","items":{"$ref":"#/components/schemas/MultiReverseFundsTransactionRequests-3"}},"acquiringBin":{"type":"integer","description":"The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment."},"acquirerCountryCode":{"type":"integer","description":"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"},"merchantCategoryCode":{"type":"integer","description":"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"},"businessApplicationId":{"type":"string","description":"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"},"localTransactionDateTime":{"type":"string","format":"date-time"}}},"MultiReverseFundsTransactionRequests-3":{"required":["amount","cardAcceptor","localTransactionDateTime","originalDataElements","retrievalReferenceNumber","senderCurrencyCode","senderPrimaryAccountNumber","systemsTraceAuditNumber","transactionIdentifier"],"type":"object","properties":{"amount":{"type":"number","description":"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.","format":"double"},"networkId":{"type":"integer","description":"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."},"surcharge":{"type":"string","description":"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.","format":"double"},"cardAcceptor":{"required":["address","idCode","name","terminalId"],"type":"object","properties":{"name":{"type":"string","description":"This field should contain the name of the originator or the money transfer operator."},"idCode":{"type":"string","description":"An identifier for the card acceptor (Visa Direct Originator). This value should be unique for each originator for whom you are sending transactions."},"address":{"required":["country"],"type":"object","properties":{"state":{"type":"string","description":"Use a 2-character abbreviated states code or territory code as the state value."},"county":{"type":"string"},"country":{"type":"string","description":"This field must contain the 3-character alpha country code for the country of the originator or money transfer operator.
Refer to ISO Codes"},"zipCode":{"type":"string"}}},"terminalId":{"type":"string","description":"The identifier for the terminal at a card acceptor location. If sending transactions from a card not present environment, use the same value for all transactions."}}},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"senderReference":{"maxLength":16,"type":"string","description":"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."},"sharingGroupCode":{"type":"string","description":"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."},"merchantReference":{"maxLength":35,"type":"string","description":"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."},"pointOfServiceData":{"type":"object","properties":{"panEntryMode":{"type":"integer","description":"For a CardPresent scenario, this field is required."},"motoECIIndicator":{"type":"string","description":"Note: If posConditionCode is 59, motoECIIndicator must be between 5-8. Default is set to 5 if not provided. If posConditionCode is 0, motoECIIndicator will not be sent."},"posConditionCode":{"type":"integer","description":"For a CardPresent scenario, this field is required."}}},"senderCurrencyCode":{"type":"string","description":"Use a 3-character alpha currency code for currency of the sender.
Refer to ISO Codes"},"feeProgramIndicator":{"type":"string","description":"If present, a valid value is required. Spaces or special characters are not allowed."},"originalDataElements":{"type":"object","properties":{"acquiringBin":{"type":"integer","description":"This field must contain the Bank Identification Number (BIN) from the original AFT."},"approvalCode":{"type":"string","description":"This field, if present, must contain the approvalCode from the original AFT."},"transmissionDateTime":{"type":"string","description":"This field must contain the transmissionDateTime from the original AFT
Example: 2016-01-15T07:03:52","format":"date-time"},"systemsTraceAuditNumber":{"type":"integer","description":"This field must contain the systemsTraceAuditNumber from the original AFT."}}},"senderCardExpiryDate":{"type":"string","description":"The expiration date for the sender's Visa account number in senderPrimaryAccountNumber."},"transactionIdentifier":{"type":"integer","description":"The VisaNet reference number for the transaction. You must use the transactionId from the initial AFT in this field.","format":"int64"},"merchantPseudoAbaNumber":{"type":"string","description":"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."},"systemsTraceAuditNumber":{"type":"integer","description":"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."},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"localTransactionDateTime":{"type":"string","format":"date-time"},"nationalReimbursementFee":{"type":"number","description":"When present, this field contains the IRF fees.","format":"double"},"pointOfServiceCapability":{"type":"object","properties":{"posTerminalType":{"type":"integer","description":"Note: Valid values if card is present include 0, 3 and 4. If card is not present, valid value is 5."},"posTerminalEntryCapability":{"maximum":1,"type":"integer","description":"Note: Valid values if card is present include 0, 2 and 9. If card is not present, valid value is 1."}}},"retrievalReferenceNumber":{"type":"string","description":"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."},"argentinaReimbursementFee":{"type":"number","description":"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.","format":"double"},"merchantVerificationValue":{"required":["mvvAcquirerAssigned","mvvVisaAssigned"],"type":"object","properties":{"mvvVisaAssigned":{"type":"string","description":"Visa assigned MVV value. E.g. 0A45AF"},"mvvAcquirerAssigned":{"type":"string","description":"Visa assists the acquirer in assigning the last four. E.g. 98FC"}},"description":"Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant."},"senderPrimaryAccountNumber":{"type":"string","description":"The primary account number of the sender's account."},"settlementServiceIndicator":{"type":"integer","description":"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. "},"foreignExchangeFeeTransaction":{"type":"number","description":"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.","format":"double"},"senderIdentificationNumberBusiness":{"type":"string","description":"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."}}},"MultiReverseFundsTransactionPostResponse-3":{"required":["statusIdentifier"],"type":"object","properties":{"networkId":{"type":"integer","description":"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."},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"statusIdentifier":{"type":"string"},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"merchantVerificationValue":{"type":"string","description":"The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned."}}}}}}
```
## Read Reverse Funds Transaction
> Read Reverse Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/reversefundstransactions/{statusIdentifier}":{"get":{"tags":["Funds Transfer API"],"summary":"Read Reverse Funds Transaction","description":"Read Reverse Funds Transaction","operationId":"readReverseFundsTransaction","parameters":[{"name":"transaction-id","in":"path","description":"transaction-id","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reverse Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReverseFundsTransactionGetResponse-3"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReverseFundsTransactionGetResponse-3"}}}}}}}},"components":{"schemas":{"ReverseFundsTransactionGetResponse-3":{"required":["actionCode","responseCode","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"actionCode":{"type":"string","description":"The results of the transaction request
Refer to actionCode
Note: : The VisaNet Response Code for the transaction"},"last4ofPAN":{"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"type":"string","description":"The authorization code from the issuer."},"responseCode":{"type":"string","description":"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"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"statusIdentifier":{"type":"string"},"customerReference":{"type":"string","description":"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."},"feeProgramIndicator":{"type":"object","properties":{}},"transmissionDateTime":{"type":"string","description":"Example: 2016-01-15T07:03:52:000Z","format":"date-time"},"transactionIdentifier":{"type":"integer","description":"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.","format":"int64"},"senderIdentificationNumberIndividual":{"type":"string","description":"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."}}}}}}
```
## Read Pull Funds Transaction
> Read Pull Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/pullfundstransactions/{statusIdentifier}":{"get":{"tags":["Funds Transfer API"],"summary":"Read Pull Funds Transaction","description":"Read Pull Funds Transaction","operationId":"readPullFundsTransaction","parameters":[{"name":"statusIdentifier","in":"path","description":"statusIdentifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pull Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PullFundsTransactionGetResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PullFundsTransactionGetResponse"}}}}}}}},"components":{"schemas":{"PullFundsTransactionGetResponse":{"required":["actionCode","responseCode","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"amount":{"type":"number","description":"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).","format":"double"},"tokenData":{"type":"object","properties":{"minimumAccountRange":{"type":"integer","description":"Visa forwards the cardholder PAN data to the acquirer in the original response message. Acquirers must not forward the first nine digits of the cardholder PAN or the full PAN to their merchants."},"tokenAssuranceMethod":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains different category value to determine the Risk Score associated with the token and transaction."}},"description":"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."},"actionCode":{"type":"string","description":"The results of the transaction request
Refer to actionCode
"},"last4ofPAN":{"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"type":"string","description":"The authorization code from the issuer."},"responseCode":{"type":"string","description":"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"},"approvedAmount":{"type":"number","description":"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).","format":"double"},"cavvResultCode":{"type":"string","description":"The cavvResultCode identifies the outcome of the CAVV validation.
Refer to cavvResultCode"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"statusIdentifier":{"type":"string"},"customerReference":{"type":"string","description":"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."},"originalActionCode":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"feeProgramIndicator":{"type":"string"},"transmissionDateTime":{"type":"string","description":"Example: 2016-01-15T07:03:52.000Z
Note: Remove \"000Z\" if this field value is used for ReverseFundsTransactions POST request or MultiReverseFundsTransactions POST request.","format":"date-time"},"riskAssessmentResults":{"type":"object","properties":{"exemptionReasonCode":{"type":"array","description":"One or more instances of reason codes that explain why an exemption was not honored.
Valid Values :
8A01 = Merchant not participating in Visa Delegated Authentication Program
8A02 = Issuer not participating in Visa Delegated Authentication Program
8A04 = Indeterminate or invalid issuer response
8A06 = Did not meet exemption criteria (Visa determined)
8A07 = VMID invalid for service
8A08 = CAVV invalid value
8A76 = Did not meet delegation criteria (Issuer supplied)
8473 = Cardholder has not trusted the merchant (issuer supplied)
8474 = Did not meet the exemption criteria (issuer supplied)
8976 = Did not meet exemption criteria (issuer supplied)
This field is present in API response only if any of the SCA exemptions were claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34, Dataset ID 4A- Tag 8C.","items":{"type":"string"}},"scpExemptionIndicator":{"type":"string","description":"Secure Corporate Payment (SCP) Indicator.
Valid Values :
HONORED - Secure corporate payment exemption validated/honored
NOT_HONORED-Secure corporate payment exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 88."},"traExemptionIndicator":{"type":"string","description":"Transaction Risk Analysis (TRA) Exemption Indicator.
Valid Values :
HONORED - Transaction risk analysis exemption validated/honored
NOT_HONORED - Transaction risk analysis exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 89."},"lowValueExemptionIndicator":{"type":"string","description":"This field is present in API response only if the following conditions are met.
- optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
- Low Value exemption was claimed in the acquirer request (OR) Issuer chooses to approve the transaction as the amount was below the issuer set low value and velocity counts limits
Valid Values :
HONORED - Low value exemption validated/honored
NOT_HONORED - Low value exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 87."},"delegatedAuthenticationIndicator":{"type":"string","description":"Delegated Authentication Indicator.
Valid Values :
HONORED - Delegated authentication request validated/honored
NOT_HONORED - Delegated authentication request failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 8A."},"trustedMerchantExemptionIndicator":{"type":"string","description":"Trusted Merchant Exemption Indicator.
Valid Values :
HONORED - Trusted merchant exemption validated/honored
NOT_HONORED - Trusted merchant exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 84."}},"description":"This object is present in the response only if the issuer supports SCA exemptions."},"transactionIdentifier":{"type":"integer","description":"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.","format":"int64"},"reimbursementAttribute":{"type":"string","description":"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.) "},"vauRTAuthReplacementData":{"type":"object","properties":{"vauFlag":{"type":"string","description":"Possible values are : Y (replacement occurred). N (No replacements)"},"vauAccntStatus":{"type":"string","description":"Indicates C (closed account) or Q (contact cardholder)"},"replacementCardID":{"type":"string","description":"The replacement pan, if it exists"},"vauErrorReasonCode":{"type":"string","description":"Conditional. If present, describes the reason the VAU failed"},"replaceDateExpiration":{"type":"string","description":"Replacement pan expiration date, if it exists. This is returned even if the expiration date was not passed in the request."}}},"transactionLinkIdentifier":{"maxLength":36,"minLength":1,"type":"string","description":"Transaction Link Identifier returned from other networks like MasterCard and Pulse"},"addressVerificationResults":{"maxLength":1,"minLength":1,"type":"string","description":"Results of the Address Verification Service (AVS) validation for the Primary Account Number.
Refer to addressVerificationResults"},"recipientIdentificationNumberIndividual":{"type":"string","description":"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)"},"cpsAuthorizationCharacteristicsIndicator":{"type":"string","description":"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."}}}}}}
```
## Create Pull Funds Transaction
> Create Pull Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/pullfundstransactions":{"post":{"tags":["Funds Transfer API"],"summary":"Create Pull Funds Transaction","description":"Create Pull Funds Transaction","operationId":"createPullFundsTransaction","requestBody":{"description":"Request body for creating in pull funds transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PullFundsTransactionPostPayload-3"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PullFundsTransactionPostPayload-3"}}},"required":true},"responses":{"200":{"description":"Pull Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PullFundsTransactionPostResponse-2"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PullFundsTransactionPostResponse-2"}}}}}}}},"components":{"schemas":{"PullFundsTransactionPostPayload-3":{"required":["acquirerCountryCode","acquiringBin","amount","businessApplicationId","cardAcceptor","localTransactionDateTime","merchantCategoryCode","pointOfServiceData","retrievalReferenceNumber","senderCurrencyCode","systemsTraceAuditNumber"],"type":"object","properties":{"cavv":{"maxLength":40,"minLength":40,"type":"string","description":"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."},"tavv":{"maxLength":40,"minLength":40,"type":"string","description":"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."},"amount":{"type":"number","description":"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.","format":"double"},"pinData":{"type":"object","properties":{"pinDataBlock":{"maxLength":16,"type":"string","description":"For a CardPresent with PIN Data scenario, this field is required."},"securityRelatedControlInfo":{"type":"object","properties":{"zoneKeyIndex":{"type":"integer","description":"Note: For a CardPresent with PIN Data scenario, this field is required."},"pinBlockFormatCode":{"type":"integer","description":"Note: For a CardPresent with PIN Data scenario, this field is required."}}}}},"vauFlag":{"maxLength":1,"minLength":1,"type":"string","description":"If present, a valid value is required. Spaces or special characters are not allowed. Possible values are : Y (will cause VAU to be performed)"},"surcharge":{"maxLength":13,"minLength":1,"type":"string","description":"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.","format":"double"},"senderCity":{"maxLength":25,"minLength":1,"type":"string","description":"When present, this field contains sender's city"},"senderName":{"maxLength":30,"minLength":2,"type":"string","description":"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"},"accountType":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"acquiringBin":{"type":"integer","description":"The Bank Identification Number (BIN) under which your Visa Direct is registered. This must match the information provided during enrollment."},"cardAcceptor":{"required":["address","idCode","name","terminalId"],"type":"object","properties":{"name":{"maxLength":25,"minLength":1,"type":"string","description":"name of the originator/money transfer operator.
The Merchant Name field must conform to the format detailed in the Visa Direct Account Funding Transactions Processing Guide AFT Implementation Guide"},"taxID":{"maxLength":35,"minLength":1,"type":"string","description":"Conditional.
This field contains the identifier of the acceptor issued by a taxation authority.
This field is conditionally required for all MasterCard transactions."},"idCode":{"maxLength":15,"minLength":1,"type":"string","description":"An identifier for the card acceptor (Visa Direct Originator). This value should be unique for each originator for whom you are sending transactions."},"address":{"required":["country"],"type":"object","properties":{"city":{"maxLength":13,"minLength":1,"type":"string","description":"Conditional.\n\nCity of the Merchant/Originator.\n\nRequired for all cross border transactions when issuer is in Canada or Australia.\n\nNote: Visa defaults this to \"VISA DIRECT\" if city is not provided."},"state":{"maxLength":50,"type":"string","description":"Conditional.\n\nState or province of the Merchant/Originator.\n\nRequired if the cardAcceptor:address:country is \"US\" or \"CA\", for all cross border transactions when issuer is in Canada or Australia, and for all MasterCard transactions.\n\nNote: For \"US\" or \"CA\", this field can contain either the full name of the state or the 2 character code of the state. For rest of the countries, if applicable, the field contains the state code of a maximum 6 characters length."},"county":{"maxLength":50,"type":"string","description":"Conditional
Note:It contains 3-digit numeric FIPS county code of the money transfer operator/Originator.
Required if cardAcceptor:address:country is \"US\"."},"country":{"maxLength":3,"minLength":1,"type":"string","description":"This field must contain the 3-character alpha country code for the country of the originator or money transfer operator.
Refer to ISO Codes"},"zipCode":{"maxLength":9,"type":"string","description":"Conditional.\n\nZip/Postal code of the Merchant/Originator.\n\nRequired if the cardAcceptor:address:country is \"US\" or \"CA\", for all cross border transactions when issuer is in Canada or Australia, and for all MasterCard transactions.\n\nNote: For \"US\", \"CA\", and US territories (Puerto Rico/Guam/US Virgin Island/American Samoa/Northern Mariana Island), the maximum length of the field is 9 characters. For rest of the countries, the maximum length of the field is 8 characters."},"addressLine":{"maxLength":99,"minLength":1,"type":"string","description":"Conditional.\n\nStreet address of the Merchant/Originator.\n\nThis field is conditionally required for all cross border transactions when issuer is in Canada or Australia and for all MasterCard transactions."}}},"terminalId":{"maxLength":8,"minLength":1,"type":"string","description":"The identifier for the terminal at a card acceptor location. If sending transactions from a card not present environment, use the same value for all transactions."},"urlAddress":{"maxLength":256,"minLength":1,"type":"string","description":"Conditional.
This field contains the web address of the acceptor.
This field is conditionally required for all MasterCard transactions."},"partnerIDCode":{"maxLength":8,"minLength":1,"type":"string","description":"Conditional.
This field identifies a specific partnership agreement, generally between specific acceptors and issuers. may be used for transactions on accounts issued under co-branding agreements when one of the co-branding partners originates the transaction.
This field is conditionally required for all MasterCard transactions."},"legalBusinessName":{"maxLength":25,"minLength":1,"type":"string","description":"Acceptor’s legal business name associated with the card acceptor identification code for AFT transactions.\n\nThis field is conditionally required for all cross border transactions when issuer is in Canada or Australia."},"contactInformation":{"type":"object","properties":{"phoneNumber":{"maxLength":16,"minLength":1,"type":"string","description":"Conditional.
This field contains the business phone number of the acceptor, if different from the acceptor customer service phone number.
This field is conditionally required for all MasterCard transactions."},"additionalContactDetails":{"maxLength":256,"minLength":1,"type":"string","description":"Conditional.
This field contains additional information for contacting the acceptor, such as an additional phone number or a contact name.
This field is conditionally required for all MasterCard transactions."},"customerServicePhoneNumber":{"maxLength":16,"minLength":1,"type":"string","description":"Conditional.
This field contains the customer service phone number of the acceptor that should be used for transaction inquiries.
This field is conditionally required for all MasterCard transactions."}}},"paymentFacilitator":{"type":"object","properties":{"id":{"maxLength":11,"minLength":1,"type":"string","description":"Marketplace ID or Payment Facilitator's ID. This field is conditionally required when a payment facilitator is involved and for all MasterCard transactions."},"name":{"maxLength":25,"minLength":1,"type":"string","description":"Payment facilitator name in AFTs. This field is conditionally required when a payment facilitator is involved."},"address":{"type":"object","properties":{"city":{"maxLength":50,"minLength":1,"type":"string","description":"City Name"},"state":{"maxLength":3,"minLength":1,"type":"string","description":"State/province Code"},"country":{"maxLength":3,"minLength":3,"type":"string","description":"Alpha Country Code"},"postalCode":{"maxLength":10,"minLength":4,"type":"string","description":"Postal code or zip code"},"streetAddress":{"maxLength":99,"minLength":1,"type":"string","description":"street Address"}}},"subMerchantId":{"maxLength":15,"minLength":1,"type":"string","description":"Sub-Merchant ID containing the sponsored merchant ID. This field is conditionally required when a payment facilitator is involved and for all MasterCard transactions."},"independentSalesOrganizationID":{"maxLength":11,"minLength":1,"type":"string","description":"Conditional.
This field contains the \"Company ID\" that is assigned during the time of registration with Mastercard Connect as a service provider and must be provided by the acquirer.
This field is conditionally required for all MasterCard transactions."}}},"serviceLocationDetails":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"maxLength":50,"minLength":1,"type":"string","description":"Conditional.\n\nThis field contains the name of the city where the cardholder received the services.\n\nThis field is conditionally required for all MasterCard transactions."},"state":{"maxLength":3,"minLength":1,"type":"string","description":"Conditional.\n\nThis field contains the ISO code of the State/Province or country subdivision where the cardholder received the services.\n\nThis field is conditionally required for all MasterCard transactions."},"postalCode":{"maxLength":10,"minLength":1,"type":"string","description":"Conditional.
This field contains the postal code of the country where the cardholder received the services.\n\nThis field is conditionally required for all MasterCard transactions."},"countryCode":{"maxLength":3,"minLength":3,"type":"string","description":"Conditional.\n\nThis field contains the 3 character alpha ISO country code of the country where the cardholder received the services. \n\nThis field is conditionally required for all MasterCard transactions.
Refer to ISO Codes"}}}}}}},"chipCardData":{"maxLength":510,"minLength":2,"type":"string","description":"A blob containing the Chip card data in TLV format"},"cardCvv2Value":{"maxLength":4,"minLength":3,"type":"string","description":"The cardCvv2Value value provided by the account holder for the senderPrimaryAccountNumber in the request."},"recipientCity":{"maxLength":25,"type":"string","description":"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."},"recipientName":{"maxLength":30,"minLength":1,"type":"string","description":"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"},"senderAddress":{"maxLength":35,"minLength":1,"type":"string","description":"When present, this field contains sender's Address
Note:
This field is not applicable for domestic Colombia transactions"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"recipientState":{"maxLength":3,"type":"string","description":"Required if RecipientCountryCode is either 124(CAN) or 840(USA)
Note:
This field is not applicable for domestic Colombia transactions"},"senderLastName":{"maxLength":35,"type":"string","description":"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"},"senderFirstName":{"maxLength":35,"type":"string","description":"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"},"senderReference":{"maxLength":16,"type":"string","description":"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."},"senderStateCode":{"maxLength":2,"minLength":2,"type":"string","description":"Conditional.
Required if senderCountryCode is either 124(CAN) or 840(USA)
Note:
This field not applicable for domestic Colombia transactions"},"purposeOfPayment":{"maxLength":12,"minLength":1,"type":"string","description":"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"},"schemeIdentifier":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"senderEntityType":{"maxLength":1,"minLength":1,"type":"string","description":"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."},"senderMiddleName":{"maxLength":35,"minLength":1,"type":"string","description":"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"},"senderOccupation":{"maxLength":35,"minLength":1,"type":"string","description":"Account Owner Occupation. Only alpha-numeric data is accepted"},"senderPostalCode":{"type":"string","description":"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."},"senderStreetName":{"maxLength":99,"type":"string","description":"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."},"sharingGroupCode":{"maxLength":30,"type":"string","description":"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."},"merchantReference":{"maxLength":35,"type":"string","description":"Conditional.
This field contains the merchant account key value for Argentina domestic purchase (POS) transactions, where businessApplicationId is \"PS\"."},"messageReasonCode":{"type":"integer","description":"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"},"recipientLastName":{"maxLength":35,"type":"string","description":"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"},"senderCountryCode":{"maxLength":3,"minLength":2,"type":"string","description":"when present, this field contains sender's country code
Refer to ISO Codes"},"senderDateOfBirth":{"type":"string","description":"Account Owner Date of Birth.(format YYYY-MM-DD)","format":"date"},"senderNationality":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of nationality in alphabets."},"sourceOfFundsCode":{"maxLength":2,"minLength":2,"type":"string","description":"when present, this field contain a valid sourceOfFundsCode code that matches the funding instrument.
Refer to sourceOfFundsCode codes"},"magneticStripeData":{"type":"object","properties":{"track1Data":{"maxLength":76,"type":"string","description":"Conditional (see Note)
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"},"track2Data":{"maxLength":19,"type":"string","description":"Note: For a CardPresent scenario, MagneticStripeData.track1Data (or MagneticStripeData.track2Data) must be included."}}},"pointOfServiceData":{"required":["motoECIIndicator","panEntryMode","posConditionCode"],"type":"object","properties":{"panEntryMode":{"type":"integer","description":"A 2-digit code that identifies the method used to enter the cardholder account number and card expiration date. This code specifies whether the entire magnetic stripe is included in an authorization or financial request.
Refer to PAN Entry Mode Codes"},"posEnvironment":{"maxLength":1,"type":"string","description":"Conditional
This field is required to identify whether a transaction is merchant-initiated.
Refer to POS Environment Codes"},"motoECIIndicator":{"maxLength":1,"type":"string","description":"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"},"posConditionCode":{"type":"integer","description":"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 CAVV and/or TAVV transaction, the POS condition code must be set to 59.
Refer to POS Condition Codes"},"specialConditionIndicatorMerchant":{"maxLength":1,"minLength":1,"type":"string","description":"1 - Purchase of Central Bank Digital Currency (CBDC) or Tokenized Deposits
2 - Purchase of Stablecoin (fiat-backed)
3 - Purchase of Blockchain Native Token/Coin
7 - Purchase of Cryptocurrency"}},"description":"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."},"recipientFirstName":{"maxLength":35,"type":"string","description":"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"},"riskAssessmentData":{"type":"object","properties":{"scpExemptionIndicator":{"type":"string","description":"Secure Corporate Payment (SCP) Indicator.
Valid Values :
FALSE - Secure corporate payment exemption not claimed/requested
TRUE - Secure corporate payment exemption claimed/requested
If this exemption does not apply to the transaction, the value of \"FALSE\" is optional and the field may be omitted entirely.
This field maps to ISO8583->TLV Field 34, Dataset ID 4A, Tag 88."},"traExemptionIndicator":{"type":"string","description":"Transaction Risk Analysis (TRA) Exemption Indicator.
Valid Values :
FALSE - Transaction risk analysis exemption not claimed/requested
TRUE - Transaction risk analysis exemption claimed/requested
If this exemption does not apply to the transaction, the value of \"FALSE\" is optional and the field may be omitted entirely.
This field maps to ISO8583->TLV Field 34, Dataset ID 4A, Tag 89."},"lowValueExemptionIndicator":{"type":"string","description":"Low Value Exemption Indicator.
Valid Values :
FALSE - Low value exemption not claimed/requested
TRUE - Low value exemption claimed/requested
If this exemption does not apply to the transaction, the value of \"FALSE\" is optional and the field may be omitted entirely.
This field maps to ISO8583->TLV Field 34, Dataset ID 4A, Tag 87."},"scaEnvironmentOutageIndicator":{"type":"string","description":"Acceptance Environment Authentication Outage Indicator.
Valid Values :
FALSE - No authentication outage
TRUE - Authentication outage
If this exemption does not apply to the transaction, the value of \"FALSE\" is optional and the field may be omitted entirely.This field maps to ISO8583 Field 34 – Dataset ID 02 -Tag 87."},"delegatedAuthenticationIndicator":{"type":"string","description":"Delegated Authentication Indicator.
Valid Values :
FALSE - Delegated authentication not claimed/requested
TRUE - Delegated authentication claimed/requested
If this exemption does not apply to the transaction, the value of \"FALSE\" is optional and the field may be omitted entirely.
Clients requesting this exemption should also provide the the following request parameters:
1. visaMerchantIdentifier value, which is an unique identifier assigned by Visa for each merchant included in the identification program.Issuers can obtain a list of Visa-assigned merchant identifiers from Visa Online (VOL).
2. Cardholder Authentication Verification Value (CAVV) OR Token Authentication Verification Value (TAVV)
Program Qualification: Acquirers that choose to participate will identify and qualify potential Delegates that meet the qualification criteria and work with them to evidence how their authentication capabilities are compliant and to obtain their agreement to the requirements of the Program through the Readiness Questionnaire. Token requestors may submit their Readiness Questionnaire directly to Visa. On a per transaction basis, the delegated entity will flag to the Issuer that SCA was performed through EMV 3DS (2.2 only) or VTS.
This field maps to ISO8583->TLV Field 34, Dataset ID 4A, Tag 8A."},"trustedMerchantExemptionIndicator":{"type":"string","description":"Trusted Merchant Exemption Indicator.
Valid Values :
FALSE - Trusted merchant exemption not claimed/requested
TRUE - Trusted merchant exemption claimed/requested
If this exemption does not apply to the transaction, the value of \"FALSE\" is optional and the field may be omitted entirely.
This field maps to ISO8583->TLV Field 34, Dataset ID 4A, Tag 84."}}},"senderAddressLine1":{"maxLength":99,"type":"string","description":"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."},"senderAddressLine2":{"maxLength":99,"type":"string","description":"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."},"senderCurrencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"- 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"},"acquirerCountryCode":{"type":"integer","description":"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"},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string","description":"If present, a valid value is required. Spaces or special characters are not allowed."},"masterCardUCAFField":{"maxLength":32,"minLength":1,"type":"string","description":"This field contains Mastercard e-commerce Universal Cardholder Authentication data in encrypted form. It may also contain Mastercard telephone order data."},"recipientEntityType":{"maxLength":1,"minLength":1,"type":"string","description":"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."},"recipientMiddleName":{"maxLength":35,"minLength":1,"type":"string","description":"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"},"recipientOccupation":{"maxLength":35,"minLength":1,"type":"string","description":"Account Owner Occupation. Only alpha-numeric data is accepted"},"recipientPostalCode":{"maxLength":16,"type":"string","description":"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."},"recipientStreetName":{"maxLength":99,"type":"string","description":"This field contains the street name of the recipient address.
Maps to the following ISO 8583 field
- Field 56, Tag 88"},"senderAccountNumber":{"maxLength":34,"type":"string","description":"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)."},"senderLocalNameData":{"required":["dataEncodingFormat","languageCode"],"type":"object","properties":{"lastName":{"maxLength":35,"minLength":1,"type":"string","description":"Sender's last name in local language."},"aliasName":{"maxLength":70,"minLength":1,"type":"string","description":"Sender's alias name in local language."},"firstName":{"maxLength":35,"minLength":1,"type":"string","description":"Sender's first name in local language."},"middleName":{"maxLength":35,"minLength":1,"type":"string","description":"Sender's middle name in local language."},"languageCode":{"maxLength":3,"minLength":3,"type":"string","description":"3 characters ISO 639 language code. Example 'heb' for Hebrew."},"dataEncodingFormat":{"maxLength":2,"minLength":2,"type":"string","description":"01 = UTF-8"}},"description":"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."},"senderMiddleInitial":{"maxLength":1,"type":"string","description":"This field contains sender's middle initial
Note:
This field is not applicable for domestic Colombia transactions"},"merchantCategoryCode":{"type":"integer","description":"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)."},"recipientCountryCode":{"maxLength":3,"minLength":2,"type":"string","description":"when present, this field contains recipient's country code
Refer to ISO Codes"},"recipientDateOfBirth":{"type":"string","description":"Account Owner Date of Birth.(format YYYY-MM-DD)","format":"date"},"recipientNationality":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of nationality in alphabets."},"senderAdditionalData":{"type":"object","properties":{"identificationList":{"type":"array","description":"Identification list of sender.
For domestic Colombia and Ukraine transactions, we will send all the instances of ID information received to the issuer.
For other transactions, we have a current limitation that sender ID and recipient ID information are mutually exclusive. If both sender ID and recipient ID are sent in the same request, only sender ID related information will be sent to the issuer. Additionally, only 1 instance of ID per sender or recipient is currently supported. If more than one instance is provided, only the first instance will be forwarded to the issuer.","items":{"type":"object","properties":{"idType":{"maxLength":4,"minLength":1,"type":"string","description":"This field will contain the type of sender identification. The valid values are: \n BTHD - Date of birth \n CUID - Customer identification - unspecified \n NTID - National identification\n PASN - Passport number\n DRLN - Driver license\n TXIN - Tax identification \n CPNY - Company registration number\n PRXY - Proxy identification \n SSNB - Social security number \n ARNB - Alien registration number \n LAWE - Law enforcement identification \n MILI - Military identification \n TRVL - Travel identification - non-passport \n EMAL - Email\n PHON - Phone number \nFor a given instance of identificationList[], a minimum of idType and idNumber fields should be provided, else the ID information will not be forwarded to the issuer."},"idNumber":{"maxLength":35,"minLength":1,"type":"string","description":"This field will contain an acquirer-populated value associated with the Identification Type in field idType \nWhen idType contains the value of BTHD (Date of birth), this tag must contain a date of birth in ccyymmdd format where: cc = century, yy = year, mm = month, dd = day \nFor a given instance of identificationList[] , a minimum of idType and idNumber fields should be provided, else the ID information will dropped and not be forwarded to the issuer."},"idOwnerType":{"maxLength":1,"minLength":1,"type":"string","description":"This field denotes whether the Tax ID is a business or individual's Tax ID when idType contains the value of TXIN (Tax identification).\nThe valid values are : \nB (Business) \nI (Individual)"},"idIssueCountry":{"maxLength":3,"minLength":3,"type":"string","description":"This tag will contain the 3-alpha or 3-digit ISO country code of the ID issuing country."}}}},"ancillarySenderDetails":{"type":"array","description":"Ancillary sender details.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"maxLength":25,"type":"string","description":"This field contains the city of the ancillary sender's address."},"postalCode":{"maxLength":16,"type":"string","description":"This field contains the postal code of the ancillary sender's address."},"streetName":{"maxLength":99,"type":"string","description":"This field contains the street name of the ancillary sender's address."},"countryCode":{"maxLength":25,"type":"string","description":"This field contains the 3 char alpha ISO country code of the ancillary sender's address.
Refer to ISO Codes"},"addressLine1":{"maxLength":99,"type":"string","description":"This field contains the first line of the ancillary sender's address."},"addressLine2":{"maxLength":99,"type":"string","description":"This field contains the second line of the ancillary sender's address."},"buildingNumber":{"maxLength":16,"type":"string","description":"This field contains the building number or house number of the ancillary sender's address."}}},"lastName":{"maxLength":35,"type":"string","description":"This field contains ancillary sender's last name"},"firstName":{"maxLength":35,"type":"string","description":"This field contains ancillary sender's first name"},"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the ancillary sender is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual."},"middleName":{"maxLength":35,"type":"string","description":"This field contains ancillary sender's middle name"}}}},"contactInformationList":{"type":"array","description":"Contact Information list of sender.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the contact information is for a business or an individual. The valid value are: 'B' for Business and 'I' for Individual."},"contactType":{"type":"string","description":"This field identifies the type of contact information. The valid value is: \"PHONE\" for phone number.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."},"contactValue":{"maxLength":16,"type":"string","description":"This field contains the contact value for provided contact type.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."}}}}}},"senderBuildingNumber":{"maxLength":16,"type":"string","description":"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."},"senderCardExpiryDate":{"type":"string","description":"This field contains the expiration date for the sender's Visa account number or token in senderPrimaryAccountNumber
Format: YYYY-MM
Example: 2021-10","format":"date"},"senderCountryOfBirth":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of birth in alphabets"},"businessApplicationId":{"maxLength":2,"minLength":2,"type":"string","description":"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"},"originalTransactionId":{"type":"integer","description":"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."},"recipientAddressLine1":{"maxLength":99,"type":"string","description":"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."},"recipientAddressLine2":{"maxLength":99,"type":"string","description":"Optional.
This field contains the second line of the recipient address."},"serviceProcessingType":{"type":"object","properties":{"requestType":{"maxLength":2,"type":"string","description":"Valid values:\n\n0B - Europe use only."}},"description":"Optional.
This field will contain values that identify the type of service the transaction should be processed."},"recipientLocalNameData":{"required":["dataEncodingFormat","languageCode"],"type":"object","properties":{"lastName":{"maxLength":35,"minLength":1,"type":"string","description":"Recipient's last name in local language."},"aliasName":{"maxLength":70,"minLength":1,"type":"string","description":"Recipient's alias name in local language."},"firstName":{"maxLength":35,"minLength":1,"type":"string","description":"Recipient's first name in local language."},"middleName":{"maxLength":35,"minLength":1,"type":"string","description":"Recipient's middle name in local language."},"languageCode":{"maxLength":3,"minLength":3,"type":"string","description":"3 characters ISO 639 language code. Example 'heb' for Hebrew."},"dataEncodingFormat":{"maxLength":2,"minLength":2,"type":"string","description":"01 = UTF-8"}},"description":"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."},"recipientMiddleInitial":{"maxLength":1,"type":"string","description":"When present, this field contains recipient's middle initial
Note:
This field is not applicable for domestic Colombia transactions"},"visaMerchantIdentifier":{"maxLength":8,"minLength":8,"type":"string","description":"Visa Merchant Identifier assigned by Visa."},"addressVerificationData":{"type":"object","properties":{"street":{"maxLength":40,"minLength":0,"type":"string","description":"Street address for address verification"},"postalCode":{"maxLength":9,"minLength":4,"type":"string","description":"Conditional
Postal Code for address verification. For US, contains 5 or 9 digit ZIP code. This field is required for the transaction to qualify for CPS qualified Interchange rates and to avoid Transaction Integrity Fee."}},"description":"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."},"merchantPseudoAbaNumber":{"maxLength":9,"minLength":9,"type":"string","description":"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."},"recipientAdditionalData":{"type":"object","properties":{"identificationList":{"type":"array","description":"Identification list of recipient.
For domestic Colombia and Ukraine transactions, we will send all the instances of ID information received to the issuer.
For other transactions, we have a current limitation that sender ID and recipient ID information are mutually exclusive. If both sender ID and recipient ID are sent in the same request, only sender ID related information will be sent to the issuer. Additionally, only 1 instance of ID per sender or recipient is currently supported. If more than one instance is provided, only the first instance will be forwarded to the issuer.","items":{"type":"object","properties":{"idType":{"maxLength":4,"minLength":1,"type":"string","description":"This field will contain the type of recipient identification. The valid values are: \n BTHD - Date of birth \n CUID - Customer identification - unspecified \n NTID - National identification\n PASN - Passport number\n DRLN - Driver license\n TXIN - Tax identification \n CPNY - Company registration number\n PRXY - Proxy identification \n SSNB - Social security number \n ARNB - Alien registration number \n LAWE - Law enforcement identification \n MILI - Military identification \n TRVL - Travel identification - non-passport \n EMAL - Email\n PHON - Phone number \nFor a given instance of identificationList[], a minimum of idType and idNumber fields should be provided, else the ID information will not be forwarded to the issuer."},"idNumber":{"maxLength":35,"minLength":1,"type":"string","description":"This field will contain an acquirer-populated value associated with the Identification Type in field idType. \nWhen idType contains the value of BTHD (Date of birth), this tag must contain a date of birth in ccyymmdd format where: cc = century, yy = year, mm = month, dd = day. \n For a given instance of identificationList[], a minimum of idType and idNumber fields should be provided, else the ID information will be dropped and not forwarded to the issuer."},"idOwnerType":{"maxLength":1,"minLength":1,"type":"string","description":"This field denotes whether the Tax ID is a business or individual's Tax ID when idType contains the value of TXIN (Tax identification).\nThe valid values are : \nB (Business) \nI (Individual)"},"idIssueCountry":{"maxLength":3,"minLength":3,"type":"string","description":"This tag will contain the 3-alpha or 3-digit ISO country code of the ID issuing country."}}}},"contactInformationList":{"type":"array","description":"Contact Information list of recipient.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the contact information is for a business or an individual. The valid value are: 'B' for Business and 'I' for Individual."},"contactType":{"type":"string","description":"This field identifies the type of contact information. The valid value is: \"PHONE\" for phone number.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."},"contactValue":{"maxLength":16,"type":"string","description":"This field contains the contact value for provided contact type.
Note:
For a given instance of contactInformationList[], a minimum of contactType and contactValue fields should be provided, else the contact information will not be forwarded to the issuer."}}}},"ancillaryRecipientDetails":{"type":"array","description":"Ancillary recipient details.
Note: This information is only applicable for domestic Colombia and Ukraine transactions. For other transactions, if the information is provided, it will be dropped.","items":{"type":"object","properties":{"address":{"type":"object","properties":{"city":{"maxLength":25,"type":"string","description":"This field contains the city of the ancillary recipient's address."},"postalCode":{"maxLength":16,"type":"string","description":"This field contains the postal code of the ancillary recipient's address."},"streetName":{"maxLength":99,"type":"string","description":"This field contains the street name of the ancillary recipient's address."},"countryCode":{"maxLength":25,"type":"string","description":"This field contains the 3 char alpha ISO country code of the ancillary recipient's address.
Refer to ISO Codes"},"addressLine1":{"maxLength":99,"type":"string","description":"This field contains the first line of the ancillary recipient's address."},"addressLine2":{"maxLength":99,"type":"string","description":"This field contains the second line of the ancillary recipient's address."},"buildingNumber":{"maxLength":16,"type":"string","description":"This field contains the building number or house number of the ancillary recipient's address."}}},"lastName":{"maxLength":35,"type":"string","description":"This field contains ancillary recipient's last name"},"firstName":{"maxLength":35,"type":"string","description":"This field contains ancillary recipient's first name"},"entityType":{"maxLength":1,"minLength":1,"type":"string","description":"This field identifies if the ancillary recipient is a business or an individual. The valid value are: 'B' for Business and 'I' for Individual."},"middleName":{"maxLength":35,"type":"string","description":"This field contains ancillary recipient's middle name"}}}}}},"recipientBuildingNumber":{"maxLength":16,"type":"string","description":"Optional.
This field contains the house or building number of the recipient address."},"recipientCountryOfBirth":{"maxLength":3,"minLength":3,"type":"string","description":"ISO country code of birth in alphabets"},"systemsTraceAuditNumber":{"type":"integer","description":"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."},"AdditionalPOSInformation":{"type":"object","properties":{"chipConditionCode":{"maximum":9,"minimum":0,"type":"integer","description":"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."},"chipTransactionIndicator":{"maximum":9,"minimum":0,"type":"integer","description":"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."},"chipAuthenticationReliabilityIndicator":{"maximum":9,"minimum":0,"type":"integer","description":"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."}}},"enablerVerificationValue":{"type":"string","description":"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.","format":"binary"},"localTransactionDateTime":{"type":"string","description":"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","format":"date-time"},"nationalReimbursementFee":{"type":"number","description":"If present, this field should contain the IRF fees.","format":"double"},"pointOfServiceCapability":{"type":"object","properties":{"posTerminalType":{"type":"integer","description":"This 1-digit code identifies the basic POS electronic terminal category.
Valid Values :
0-Unspecified
3-Unattended cardholder-activated, authorized transaction Use to indicate that the transaction has all following characteristics: Occurs in an unattended cardholder-activated environment.Is authorized online or approved offline.Examples are: Movie and game rentals and Automated retail
4-Electronic cash register
5-Unattended customer terminal (intended for use in the LAC region only)
7-Telephone device (including Visa dial terminals)
8-Reserved
9-Use to identify that an mPOS device is used to originate a transaction on an open network
Note: For a CardPresent Transactions, this field is required.
"},"posTerminalEntryCapability":{"type":"integer","description":"This 1-digit code identifies the capability of the terminal to electronically read account numbers (and expiration dates) from cards.
Valid Values :
0-Unknown codes
1-Terminal not used
2-Magnetic stripe read capability
3-QR code
4-OCR read capability
5-Contact chip, magnetic-stripe, or proximity-capable terminal, indicating that the terminal can read the chip and the magnetic stripe on the card.
If contact chip is supported, a 5 should be used regardless of whether Visa Contactless is also supported.
6-Reserved for future use
7-Reserved for future use
Note: For a CardPresent Transactions, this field is required.
"},"acceptsPartialAuthorizations":{"type":"string","description":"This field is optional. This field is sent only to participating issuers. Participating originators/acquirers may submit a value of TRUE in this field if the POS systems can accept partially approved transactions. \nValid values: \nFALSE - Terminal does not support partial authorization. \nTRUE - Terminal accepts partial authorization responses. \n\n Note: If a value is entered in this field, the posTerminalEntryCapability and posTerminalType fields must be provided.","enum":["TRUE","FALSE"]}},"description":"Note: This object and the nested fields are required for CardPresent Transaction and Partial Authorizations transactions."},"retrievalReferenceNumber":{"maxLength":12,"minLength":12,"type":"string","description":"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."},"merchantVerificationValue":{"required":["mvvAcquirerAssigned","mvvVisaAssigned"],"type":"object","properties":{"mvvVisaAssigned":{"maxLength":6,"minLength":6,"type":"string","description":"Visa assigned MVV value. E.g. 0A45AF"},"mvvAcquirerAssigned":{"maxLength":4,"minLength":4,"type":"string","description":"Visa assists the acquirer in assigning the last four. E.g. 98FC"}},"description":"Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant."},"mexicoNationalServiceData":{"required":["reimbursementFee","reimbursementFeeTax"],"type":"object","properties":{"irfType":{"maxLength":1,"minLength":1,"type":"string","description":"This field contains one of the following values:
0 - Unknown/default
1 - Fixed
2 - Ad valorem (%)
3 - Composite (fixed amount and ad valorem)"},"accountType":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains one of the following values:
CO - Commercial products
CR - Credit
DB - Debit
PL - Private label
PP - Prepaid"},"irfCategoryCode":{"maxLength":2,"minLength":1,"type":"string","description":"This field optionally contains any value from 00 to 99."},"merchantFiscalId":{"maxLength":13,"type":"string","description":"This field contains RFC for the merchant. This is an alphanumeric field. The RFC format can be AAAANNNNNNAAA, where A is alphanumeric value and N is a numeric value."},"reimbursementFee":{"type":"number","description":"This field contains the Client-Calculated Interchange Reimbursement Fee in the same currency as the transaction. It must not contain zeros.","format":"double"},"reimbursementFeeTax":{"type":"number","description":"This field contains the VAT calculated for the IRF applicable to the transaction. It must not contain zeros.","format":"double"}},"description":"Settlement Service Data object for Mexico required if transaction indicates Mexico national settlement."},"transactionLinkIdentifier":{"maxLength":36,"minLength":1,"type":"string","description":"Transaction Link Identifier returned from other networks like MasterCard and Pulse"},"optionalResponseParameters":{"maxLength":400,"type":"string","description":"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)"},"senderPersonalEmailAddress":{"maxLength":99,"minLength":1,"type":"string","description":"Account owner email address."},"senderPrimaryAccountNumber":{"maxLength":19,"minLength":13,"type":"string","description":"This is a 16-digit PAN or token of the sender's account."},"settlementServiceIndicator":{"type":"integer","description":"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. "},"colombiaNationalServiceData":{"required":["countryCodeNationalService","nationalNetReimbursementFeeBaseAmount"],"type":"object","properties":{"addValueTaxAmount":{"type":"number","description":"This is the national government tax for added value of good or service.","format":"double"},"addValueTaxReturn":{"type":"number","description":"This is base value of the IVA (Sales tax). Optional. This field indicates base value of the IVA ( Sales tax which is part of the benefit of the tax legislations for the 2% sale tax return to the cardholder.","format":"double"},"taxAmountConsumption":{"type":"number","description":"This is the national consumption tax amount.","format":"double"},"nationalNetMiscAmount":{"type":"number","description":"This is an amount field that contains an airport charge, cashback or a tip.","format":"double"},"emvTransactionIndicator":{"maxLength":1,"type":"string","description":"Contains one of the below valid values:
0 - Does not apply to EMV
1 - EMV transaction
2 - Fallback transaction"},"costTransactionIndicator":{"maxLength":1,"type":"string","description":"Contains one of the below valid values:
0 - Not a cost inquiry amount
1 - Cost inquiry transaction"},"nationalChargebackReason":{"type":"integer","description":"Contains a domestic chargeback reason code."},"nationalReimbursementFee":{"type":"number","description":"Numeric entry indicating a fee for a National Settlement transaction. It must be zeros unless the transaction is a National Settlement transaction for a country using this capability. Two decimal positions are implied.","format":"double"},"nationalNetMiscAmountType":{"maxLength":1,"type":"string","description":"It identifies the type of the miscellaneous amount – i.e. whether it is one of:
A - Airport charge
C - Cashback
T - Tip
Must be one of the above valid values if nationalNetMiscAmount > 0.
Must be skipped if nationalNetMiscAmount = 0."},"countryCodeNationalService":{"type":"integer","description":"The acquirer's country code. Must be 170 for Colombia."},"nationalNetReimbursementFeeBaseAmount":{"type":"number","description":"The client supplied interchange reimbursement amount expressed in the transaction currency. This must be less than the transaction amount.","format":"double"}},"description":"Settlement Service Data object for Colombia required if transaction indicates Colombia national settlement"},"argentinaNationalServiceData":{"required":["reimbursementFee"],"type":"object","properties":{"reimbursementFee":{"type":"number","description":"This field contains the Argentina member supplied reimbursement fee. This value should be greater than 0 for Argentina Domestic Purchase transactions.","format":"double"},"reimbursementFeeTax":{"type":"number","description":"Conditional.
This field contains the VAT calculated for the IRF applicable to the transaction.","format":"double"}},"description":"Settlement Service Data object for Argentina required if transaction indicates Argentina national settlement."},"foreignExchangeFeeTransaction":{"type":"number","description":"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.","format":"double"},"recipientPersonalEmailAddress":{"maxLength":99,"minLength":1,"type":"string","description":"Account owner email address."},"recipientSubDivisionMinorCode":{"maxLength":16,"type":"string","description":"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"},"remoteCommerceAcceptorIdentifier":{"maxLength":150,"minLength":1,"type":"string","description":"This field contains a merchant identifier encoded as Base64. For example website URL or reverse domain name."},"senderPaymentCredentialReference":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["PCI_TOKEN_REFID"]},"value":{"maxLength":75,"minLength":1,"type":"string"},"merchantId":{"maxLength":50,"minLength":1,"type":"string","description":"Conditional
Unique Merchant Identification assigned by Token Service Provider. "}},"description":"Object to carry a payment instrument that is an alternative to PAN or network token e.g. PCI Token Reference ID\n\nConditional\nOnly one of 'senderPrimaryAccountNumber' and 'senderPaymentCredentialReference' is provided in a request\n"},"masterCardUCAFCollectionIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"E-commerce indicator that Mastercard Universal Cardholder Authentication data is included in the message."},"masterCardMerchantPaymentGatewayId":{"maxLength":11,"minLength":1,"type":"string","description":"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."},"recipientAccountIdentificationData":{"type":"object","properties":{"recipientAccountIdentifierValue":{"maxLength":34,"minLength":1,"type":"string","description":"Conditional.
This field contains the account identifier value for recipient account identifier type.
Required for transaction routed over non Visa networks through Push Payment Gateway Service.
Maps to the following ISO 8583 field
- Field 56, DSI01 Tag 83"},"recipientAccountIdentifierTypeCode":{"maxLength":2,"type":"string","description":"Conditional.
This field will contain the account identifier type.
Refer to Account Identifier Type Codes codes.
Required for transaction routed over non Visa networks through Push Payment Gateway Service.
Maps to the following ISO 8583 field
- Field 56, DSI01 Tag 84"}}},"recipientIdentificationNumberBusiness":{"maxLength":20,"type":"string","description":"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)."},"recipientIdentificationNumberIndividual":{"maxLength":13,"type":"string","description":"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
"},"cpsAuthorizationCharacteristicsIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"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. "},"digitalSecureRemotePaymentTokenCryptogram":{"maxLength":28,"minLength":28,"type":"string","description":"This field contains Mastercard digital payment/Cryptogram data associated with the token."}}},"PullFundsTransactionPostResponse-2":{"required":["actionCode","responseCode","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"amount":{"type":"number","description":"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).","format":"double"},"networkId":{"type":"integer","description":"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."},"tokenData":{"type":"object","properties":{"minimumAccountRange":{"type":"integer","description":"Visa forwards the cardholder PAN data to the acquirer in the original response message. Acquirers must not forward the first nine digits of the cardholder PAN or the full PAN to their merchants."},"tokenAssuranceMethod":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains different category value to determine the Risk Score associated with the token and transaction."}},"description":"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."},"actionCode":{"maxLength":2,"minLength":2,"type":"string","description":"The results of the transaction request
Refer to actionCode"},"last4ofPAN":{"type":"integer","description":"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."},"approvalCode":{"maxLength":6,"minLength":6,"type":"string","description":"The authorization code from the issuer."},"chipCardData":{"maxLength":510,"minLength":2,"type":"string","description":"A blob containing the Chip card data in TLV format"},"responseCode":{"maxLength":1,"minLength":1,"type":"string","description":"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"},"approvedAmount":{"type":"number","description":"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).","format":"double"},"cavvResultCode":{"maxLength":1,"minLength":1,"type":"string","description":"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"},"cvv2ResultCode":{"maxLength":1,"minLength":1,"type":"string","description":"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"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"settlementFlags":{"required":["settlementResponsibilityFlag"],"type":"object","properties":{"givUpdatedFlag":{"maxLength":5,"minLength":5,"type":"string","description":"Possible values are true or false"},"settlementServiceFlag":{"maxLength":1,"minLength":1,"type":"string","description":"Possible values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement
"},"givPreviouslyUpdatedFlag":{"maxLength":5,"minLength":5,"type":"string","description":"Possible values are true or false"},"settlementResponsibilityFlag":{"maxLength":5,"minLength":5,"type":"string","description":"Possible values are true or false"}},"description":""},"statusIdentifier":{"type":"string"},"supplementalData":{"type":"object","properties":{"dafIndicator":{"maxLength":5,"type":"string","description":"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"}},"description":"This field will contain supplemental values for a transaction."},"customerReference":{"maxLength":17,"type":"string","description":"Conditional
This field contains a value that identifies the customer."},"originalActionCode":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"pointOfServiceData":{"type":"object","properties":{"motoECIIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"Conditional
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.
Refer to Moto ECI Codes"}},"description":"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."},"responseReasonCode":{"maxLength":4,"minLength":1,"type":"string","description":"This field contains the merchant advice code value received from Mastercard authorization response messages."},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string"},"transmissionDateTime":{"type":"string","description":"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","format":"date-time"},"riskAssessmentResults":{"type":"object","properties":{"exemptionReasonCode":{"type":"array","description":"One or more instances of reason codes that explain why an exemption was not honored.
Valid Values :
8A01 = Merchant not participating in Visa Delegated Authentication Program
8A02 = Issuer not participating in Visa Delegated Authentication Program
8A04 = Indeterminate or invalid issuer response
8A06 = Did not meet exemption criteria (Visa determined)
8A07 = VMID invalid for service
8A08 = CAVV invalid value
8A76 = Did not meet delegation criteria (Issuer supplied)
8473 = Cardholder has not trusted the merchant (issuer supplied)
8474 = Did not meet the exemption criteria (issuer supplied)
8976 = Did not meet exemption criteria (issuer supplied)
This field is present in API response only if any of the SCA exemptions were claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34, Dataset ID 4A- Tag 8C.","items":{"maxLength":4,"minLength":4,"type":"string"}},"scpExemptionIndicator":{"type":"string","description":"Secure Corporate Payment (SCP) Indicator.
Valid Values :
HONORED - Secure corporate payment exemption validated/honored
NOT_HONORED-Secure corporate payment exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 88."},"traExemptionIndicator":{"type":"string","description":"Transaction Risk Analysis (TRA) Exemption Indicator.
Valid Values :
HONORED - Transaction risk analysis exemption validated/honored
NOT_HONORED - Transaction risk analysis exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 89."},"lowValueExemptionIndicator":{"type":"string","description":"This field is present in API response only if the following conditions are met.
- optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
- Low Value exemption was claimed in the acquirer request (OR) Issuer chooses to approve the transaction as the amount was below the issuer set low value and velocity counts limits
Valid Values :
HONORED - Low value exemption validated/honored
NOT_HONORED - Low value exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 87."},"delegatedAuthenticationIndicator":{"type":"string","description":"Delegated Authentication Indicator.
Valid Values :
HONORED - Delegated authentication request validated/honored
NOT_HONORED - Delegated authentication request failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 8A."},"trustedMerchantExemptionIndicator":{"type":"string","description":"Trusted Merchant Exemption Indicator.
Valid Values :
HONORED - Trusted merchant exemption validated/honored
NOT_HONORED - Trusted merchant exemption failed validation/not honored
This field is present in API response only if the exemption was claimed and optionalResponseParameters field was set to include \"RISKASSESSMENTDATA\" as one of the comma separated values in the API request.
This field maps to ISO8583 Field 34 – Dataset ID 4A -Tag 84."}},"description":"This object is present in the response only if the issuer supports SCA exemptions."},"serviceProcessingType":{"type":"object","properties":{"requestType":{"maxLength":2,"type":"string","description":"Reserved for future use."}},"description":"This field will contain values that identifies the type of service assigned for the transaction."},"transactionIdentifier":{"type":"integer","description":"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.","format":"int64"},"reimbursementAttribute":{"maxLength":1,"type":"string","description":"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."},"additionalTokenRespInfo":{"maxLength":1,"minLength":1,"type":"string","description":"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."},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"vauRTAuthReplacementData":{"type":"object","properties":{"vauFlag":{"maxLength":1,"minLength":1,"type":"string","description":"Possible values are : Y (replacement occurred). N (No replacements)"},"vauAccntStatus":{"maxLength":1,"minLength":1,"type":"string","description":"Indicates C (closed account) or Q (contact cardholder)"},"replacementCardID":{"maxLength":28,"minLength":1,"type":"string","description":"The replacement pan, if it exists"},"vauErrorReasonCode":{"maxLength":6,"minLength":6,"type":"string","description":"Conditional. If present, describes the reason the VAU failed"},"replaceDateExpiration":{"type":"string","description":"Replacement pan expiration date, if it exists. This is returned even if the expiration date was not passed in the request."}}},"merchantVerificationValue":{"maxLength":10,"minLength":10,"type":"string","description":"The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned."},"transactionLinkIdentifier":{"maxLength":36,"minLength":1,"type":"string","description":"Transaction Link Identifier returned from other networks like MasterCard and Pulse"},"addressVerificationResults":{"maxLength":1,"minLength":1,"type":"string","description":"Results of the Address Verification Service (AVS) validation for the Primary Account Number.
Refer to addressVerificationResults"},"senderIdentificationNumberIndividual":{"maxLength":13,"type":"string","description":"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."},"masterCardElectronicCommerceIndicators":{"maxLength":19,"minLength":7,"type":"string","description":"This field contains the security-level indicator for Mastercard issuer-authenticated transactions."},"cpsAuthorizationCharacteristicsIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"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."}}}}}}
```
## Create Multi Push Funds Transaction
> Create Multi Push Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/multipushfundstransactions":{"post":{"tags":["Funds Transfer API"],"summary":"Create Multi Push Funds Transaction","description":"Create Multi Push Funds Transaction","operationId":"createMultiPushFundsTransaction","requestBody":{"description":"Request body for creating in multi push funds transfer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPushFundsTransactionPostPayload-1"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiPushFundsTransactionPostPayload-1"}}},"required":true},"responses":{"200":{"description":"Multi Push Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPushFundsTransactionPostResponse-1"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiPushFundsTransactionPostResponse-1"}}}}}}}},"components":{"schemas":{"MultiPushFundsTransactionPostPayload-1":{"required":["acquirerCountryCode","acquiringBin","businessApplicationId","localTransactionDateTime","request"],"type":"object","properties":{"request":{"type":"array","items":{"$ref":"#/components/schemas/MultiPushFundsTransactionRequests-1"}},"acquiringBin":{"type":"integer","description":"The Bank Identification Number (BIN) under which the Visa Direct solution is registered. This must match the information provided during enrollment."},"messageReasonCode":{"type":"integer","description":"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."},"acquirerCountryCode":{"type":"integer","description":"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"},"merchantCategoryCode":{"type":"integer","description":"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"},"businessApplicationId":{"maxLength":2,"minLength":2,"type":"string","description":"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"},"localTransactionDateTime":{"type":"string","format":"date-time"},"nationalReimbursementFee":{"type":"number","description":"When present, this field contains the IRF fees.","format":"double"},"settlementServiceIndicator":{"type":"integer","description":"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. "},"senderIdentificationNumberBusiness":{"maxLength":20,"type":"string","description":"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."},"senderIdentificationNumberIndividual":{"maxLength":13,"type":"string","description":"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."}}},"MultiPushFundsTransactionRequests-1":{"required":["amount","cardAcceptor","localTransactionDateTime","recipientPrimaryAccountNumber","retrievalReferenceNumber","senderAddress","senderCity","senderName","senderPostalCode","systemsTraceAuditNumber"],"type":"object","properties":{"amount":{"type":"number","description":"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.","format":"double"},"surcharge":{"maxLength":13,"minLength":1,"type":"string","description":"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.","format":"double"},"senderCity":{"maxLength":25,"minLength":1,"type":"string","description":"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."},"senderName":{"maxLength":30,"minLength":2,"type":"string","description":"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"},"accountType":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"cardAcceptor":{"required":["address","idCode","name","terminalId"],"type":"object","properties":{"name":{"maxLength":25,"minLength":1,"type":"string","description":"If the transaction is a money transfer, the field must contain the sender's name.
If the transaction is a funds disbursement, the field must contain either the name of the merchant or government entity sending the funds disbursement.
If the transaction is a pre-paid load, the field must contain either the name of the load partner providing the reload service or the bank designated service name, if offered over bank channels
If the transaction is a credit card bill pay, the field must contain either the name of the entity providing the credit card bill pay service or the bank designated service name, if offered over bank channels."},"idCode":{"maxLength":15,"minLength":1,"type":"string","description":"An identifier for the card acceptor (Visa Direct Originator). This value should be unique for each originator for whom you are sending transactions."},"address":{"required":["city","country"],"type":"object","properties":{"city":{"maxLength":13,"minLength":1,"type":"string","description":"City of the Merchant/Originator."},"state":{"maxLength":2,"minLength":2,"type":"string","description":"Must be the state or province of the Merchant/Originator.Note:Required if cardAcceptor:address:country is \"US\" or \"CA\"."},"county":{"maxLength":3,"minLength":3,"type":"string","description":"Note:Must be the county of the Merchant/Originator.
Required if cardAcceptor:address:country is \"US\"."},"country":{"maxLength":3,"minLength":2,"type":"string","description":"Valid inputs (US example in brackets [])
ISO country code (2 alpha) [example: \"US\"]
ISO country code (3 alpha) [example: \"USA\"]
ISO country code (3 numeric) [example: \"840\"].
Refer to ISO Codes"},"zipCode":{"maxLength":9,"minLength":5,"type":"string","description":"Zip/Postal code of the money transfer operator/Originator.
Required if country is \"US\" or \"CA\"."}}},"terminalId":{"maxLength":8,"minLength":1,"type":"string","description":"The identifier for the terminal at a card acceptor location. If sending transactions from a card not present environment, use the same value for all transactions."}}},"sourceAmount":{"type":"number","description":"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.","format":"double"},"cardCvv2Value":{"maxLength":4,"minLength":3,"type":"string","description":"The cardCvv2Value provided by the account holder for the recipientPrimaryAccountNumber in the request. cardCvv2Value is required for Mastercard transaction with BAI=GP(Gambling Payout)"},"recipientCity":{"maxLength":25,"type":"string","description":"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."},"recipientName":{"type":"string","description":"Recipient name is required for cross-border enhanced money transfer OCTs."},"senderAddress":{"maxLength":35,"minLength":1,"type":"string","description":"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."},"recipientState":{"maxLength":3,"type":"string","description":"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) "},"senderLastName":{"maxLength":35,"type":"string","description":"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."},"senderFirstName":{"maxLength":35,"type":"string","description":"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."},"senderReference":{"maxLength":16,"type":"string","description":"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."},"senderStateCode":{"maxLength":2,"minLength":2,"type":"string","description":"Required if SenderCountryCode is either 124(CAN) or 840(USA)"},"purposeOfPayment":{"maxLength":12,"minLength":1,"type":"string","description":"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."},"senderMiddleName":{"maxLength":35,"minLength":1,"type":"string","description":"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)."},"senderPostalCode":{"type":"string","description":"When present, this field contains the sender's postal code"},"sharingGroupCode":{"maxLength":30,"type":"string","description":"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."},"customerReference":{"maxLength":17,"type":"string","description":"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."},"messageReasonCode":{"type":"integer","description":"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."},"recipientLastName":{"maxLength":35,"type":"string","description":"When present, this field contains recipient's last name"},"senderCountryCode":{"maxLength":3,"minLength":2,"type":"string","description":"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"},"senderDateOfBirth":{"type":"string","description":"The birth date for the sender "},"sourceOfFundsCode":{"maxLength":2,"minLength":2,"type":"string","description":"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"},"purchaseIdentifier":{"required":["referenceNumber","type"],"type":"object","properties":{"type":{"maxLength":1,"minLength":1,"type":"string","description":"This field should be populated with value 1 if sending the Request to Pay ID in the referenceNumber."},"referenceNumber":{"maxLength":25,"minLength":25,"type":"string","description":"Populate this field with the reference identifier for which the payment is being sent. For example, a request to pay ID or other unique ID related to this payment."}},"description":"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."},"recipientFirstName":{"maxLength":35,"type":"string","description":"When present, this field contains recipient's first name"},"sourceCurrencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"Conditional
3-character alpha or numeric currency code for currency of the sourceAmount field.
Refer to ISO Codes "},"feeProgramIndicator":{"maxLength":3,"minLength":3,"type":"string","description":"Note: If present, a valid value is required. Spaces or special characters are not allowed."},"recipientMiddleName":{"maxLength":35,"minLength":1,"type":"string","description":"This field contains recipient's middle name"},"recipientPostalCode":{"maxLength":16,"type":"string","description":"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."},"recipientStreetName":{"maxLength":99,"type":"string","description":"Optional.
This field contains the street name of the recipient address."},"senderAccountNumber":{"maxLength":34,"minLength":0,"type":"string","description":"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."},"senderMiddleInitial":{"maxLength":1,"type":"string","description":"This field contains sender's middle initial"},"recipientCountryCode":{"maxLength":3,"minLength":2,"type":"string","description":"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."},"recipientAddressLine1":{"maxLength":99,"type":"string","description":"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."},"recipientAddressLine2":{"maxLength":99,"type":"string","description":"Optional.
This field contains the second line of the recipient address."},"serviceProcessingType":{"required":["requestType"],"type":"object","properties":{"requestType":{"maxLength":2,"minLength":2,"type":"string","description":"Reserved for future use."}},"description":"This field will contain values that identify the type of service the transaction should be processed."},"transactionIdentifier":{"type":"integer","description":"The VisaNet transaction identifier. If you have previously sent an AFT, this field must include the VisaNet transaction identifier returned in the AFT response.","format":"int64"},"recipientMiddleInitial":{"maxLength":1,"type":"string","description":"When present, this field contains recipient's middle initial"},"merchantPseudoAbaNumber":{"maxLength":9,"minLength":9,"type":"string","description":"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."},"recipientBuildingNumber":{"maxLength":16,"type":"string","description":"Optional.
This field contains the house or building number of the recipient address."},"recipientCardExpiryDate":{"type":"string","description":"The expiration date for the recipient's primary account number in recipientPrimaryAccountNumber"},"systemsTraceAuditNumber":{"type":"integer","description":"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."},"transactionCurrencyCode":{"maxLength":3,"minLength":3,"type":"string","description":"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"},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"localTransactionDateTime":{"type":"string","format":"date-time"},"nationalReimbursementFee":{"type":"number","description":"When present, this field contains the IRF fees.","format":"double"},"retrievalReferenceNumber":{"maxLength":12,"minLength":12,"type":"string","description":"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."},"argentinaReimbursementFee":{"type":"number","description":"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.","format":"double"},"merchantVerificationValue":{"required":["mvvAcquirerAssigned","mvvVisaAssigned"],"type":"object","properties":{"mvvVisaAssigned":{"maxLength":6,"minLength":6,"type":"string","description":"Visa assigned MVV value. E.g. 0A45AF"},"mvvAcquirerAssigned":{"maxLength":4,"minLength":4,"type":"string","description":"Visa assists the acquirer in assigning the last four. E.g. 98FC"}},"description":"Merchant Verification Value(MVV) is used to identify merchants that participate in a variety of programs. The MVV is unique to the merchant."},"settlementServiceIndicator":{"type":"integer","description":"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. "},"recipientPrimaryAccountNumber":{"maxLength":19,"minLength":13,"type":"string","description":"The recipient's PAN."},"recipientSubDivisionMinorCode":{"maxLength":16,"type":"string","description":"Optional.
This field contains the ISO subdivision minor code (for e.g. a county within a state) of the recipient address."},"senderIdentificationNumberBusiness":{"maxLength":20,"type":"string","description":"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)"},"senderIdentificationNumberIndividual":{"maxLength":13,"type":"string","description":"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."}}},"MultiPushFundsTransactionPostResponse-1":{"required":["statusIdentifier"],"type":"object","properties":{"networkId":{"type":"integer","description":"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."},"cvv2ResultCode":{"maxLength":1,"minLength":1,"type":"string","description":"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"},"statusIdentifier":{"type":"string"},"serviceProcessingType":{"required":["requestType"],"type":"object","properties":{"requestType":{"maxLength":2,"minLength":2,"type":"string","description":"Reserved for future use."}},"description":"This field will contain values that identifies the type of service assigned for the transaction."},"enablerVerificationValue":{"maxLength":5,"minLength":5,"type":"string","description":"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."},"merchantVerificationValue":{"maxLength":10,"minLength":10,"type":"string","description":"The concatenated Merchant Verification Value of Visa assigned and Acquirer assigned value is returned."}}}}}}
```
## Read Multi Reverse Funds Transaction
> Read Multi Reverse Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/multireversefundstransactions/{statusIdentifier}":{"get":{"tags":["Funds Transfer API"],"summary":"Read Multi Reverse Funds Transaction","description":"Read Multi Reverse Funds Transaction","operationId":"readMultiReverseFundsTransaction","parameters":[{"name":"statusIdentifier","in":"path","description":"Status Identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Multi Reverse Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiReverseFundsTransactionGetResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiReverseFundsTransactionGetResponse"}}}}}}}},"components":{"schemas":{"MultiReverseFundsTransactionGetResponse":{"required":["actionCode","responseCode","statusIdentifier","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"actionCode":{"type":"string","description":"The results of the transaction request
Refer to actionCode
Note: : The VisaNet Response Code for the transaction"},"last4ofPAN":{"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"type":"string","description":"The authorization code from the issuer."},"responseCode":{"type":"string","description":"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"},"memberComments":{"maxLength":254,"minLength":1,"type":"string","description":"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."},"settlementFlags":{"required":["settlementResponsibilityFlag"],"type":"object","properties":{"givUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementServiceFlag":{"type":"string","description":"Possible values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement
"},"givPreviouslyUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementResponsibilityFlag":{"type":"string","description":"Possible values are true or false"}},"description":""},"statusIdentifier":{"type":"string"},"customerReference":{"type":"string","description":"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."},"feeProgramIndicator":{"type":"object","properties":{}},"transmissionDateTime":{"type":"string","description":"Example: 2016-01-15T07:03:52:000Z","format":"date-time"},"transactionIdentifier":{"type":"integer","description":"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.","format":"int64"},"enablerVerificationValue":{"type":"string","description":"This field is to allow the application of the interchange discount at the enabler level.","format":"binary"},"senderIdentificationNumberIndividual":{"type":"string","description":"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."}}}}}}
```
## Read Push Funds Transaction
> Get the status and details for a specific PushFundsTransactions POST request.The PushFundsTransactions GET operation can be invoked when the initial PushFundsTransactions POST request has returned a timeout error. When a timeout occurs, the response will include the appropriate PushFundsTransactions Link header which the client then uses to get the status and details of the initial request.
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/pushfundstransactions/{statusIdentifier}":{"get":{"tags":["Funds Transfer API"],"summary":"Read Push Funds Transaction","description":"Get the status and details for a specific PushFundsTransactions POST request.The PushFundsTransactions GET operation can be invoked when the initial PushFundsTransactions POST request has returned a timeout error. When a timeout occurs, the response will include the appropriate PushFundsTransactions Link header which the client then uses to get the status and details of the initial request.","operationId":"readPushFundsTransaction","parameters":[{"name":"statusIdentifier","in":"path","description":"Status Identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Push Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PushFundsTransactionGetResponse-1"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PushFundsTransactionGetResponse-1"}}}}}}}},"components":{"schemas":{"PushFundsTransactionGetResponse-1":{"required":["actionCode","responseCode","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"tokenData":{"type":"object","properties":{"tokenAssuranceMethod":{"maxLength":2,"minLength":2,"type":"string","description":"This field contains different category value to determine the Risk Score associated with the token and transaction."}},"description":"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."},"actionCode":{"type":"string","description":"The results of the transaction request
Refer to action code
Note: : The VisaNet Response Code for the transaction"},"last4ofPAN":{"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"type":"string","description":"The authorization code from the issuer."},"persistentFX":{"type":"object","properties":{"exchangeRate":{"type":"number","description":"PFX Exchange Rate decimal","format":"bigDecimal"},"visaRateTableId":{"maxLength":5,"minLength":1,"type":"string","description":"Rate table Id of the PFX exchange rate"},"visaRateProvider":{"maxLength":70,"minLength":1,"type":"string","description":"Provider of the PFX exchange rate"}}},"responseCode":{"type":"string","description":"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"},"prepaidBalance":{"type":"string","description":"Min Inclusive: -999999999.999
Max Inclusive: 999999999.999
Applicable only for Top Up Transactions"},"settlementInfo":{"type":"object","properties":{"settlementAmount":{"type":"number","description":"Transaction amount converted in settlement currency","format":"bigDecimal"},"settlementCurrencyCode":{"type":"integer","description":"Settlement Currency code."},"settlementConversionRate":{"type":"number","description":"Exchange Rate used to convert the transaction amount to settlement amount in case of multi-currency
Note:
get the value in decimal values by combining rate value with rate decimal positions","format":"bigDecimal"}},"description":"Note:
get the value in decimal values by combining rate value with rate decimal positions"},"deferredOCTData":{"required":["requestType"],"type":"object","properties":{"requestType":{"maxLength":2,"minLength":2,"type":"string","description":"00 : (Not a deferred OCT). This value indicates that the request is not a deferred OCT. Visa will send this value to the recipient issuer in the request. This acts as the default value if not provided in the request.
01 : (Originator hold). This value indicates that the originating acquirer has held the OCT for a period of time before sending to Visa and is requesting for Visa to treat the transaction as a deferred OCT. Visa will send this value to the recipient issuer in the request.
Note: The value of 01 is reserved for originating acquirers that meet certain conditions. Contact your regional client support representative for more information.
02 : (Visa deferred OCT hold, default interval).This value indicates that the originating acquirer is requesting Visa to apply the default holding period of 48 hours upon receipt and process the request as a deferred OCT. Visa will send this value to the recipient issuer in the request.
03 : (Visa deferred OCT hold, client defined interval).This value indicates that the originating acquirer is requesting Visa to apply the client defined holding period (provided in deferredDateTime field) upon receipt and process the request as a deferred OCT. Visa will send this value to the recipient issuer in the request."},"deferredDateTime":{"maxLength":12,"minLength":12,"type":"string","description":"If exist, identifies when the transaction will be processed by Visa. Format of this value will be in CCYYMMDDHHMM.
CC - Current Century
YY - Year
MM - Month
DD - date
HH - Hour
MM - Minute"}},"description":"Requesting Visa to process the request as a deferred OCT transaction."},"statusIdentifier":{"type":"string","description":"required when call times out"},"originalActionCode":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"responseReasonCode":{"maxLength":4,"minLength":1,"type":"string","description":"This field contains the merchant advice code value received from Mastercard authorization response messages."},"feeProgramIndicator":{"type":"string"},"transmissionDateTime":{"type":"string","description":"Example: 2016-01-15T07:03:52.000Z","format":"date-time"},"transactionIdentifier":{"type":"integer","description":"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.","format":"int64"},"prepaidBalanceCurrency":{"type":"string","description":"Applicable only for Top Up Transactions"},"vauRTAuthReplacementData":{"type":"object","properties":{"vauFlag":{"type":"string","description":"Possible values are : Y (replacement occurred). N (No replacements)"},"vauAccntStatus":{"type":"string","description":"Indicates C (closed account) or Q (contact cardholder)"},"replacementCardID":{"type":"string","description":"The replacement pan, if it exists"},"vauErrorReasonCode":{"type":"string","description":"Conditional. If present, describes the reason the VAU failed"},"replaceDateExpiration":{"type":"string","description":"Replacement pan expiration date, if it exists. This is returned even if the expiration date was not passed in the request."}}},"transactionLinkIdentifier":{"maxLength":36,"minLength":1,"type":"string","description":"Transaction Link Identifier returned from other networks like MasterCard and Pulse"}}}}}}
```
## Read Multi Push Funds Transaction
> Read Multi Push Funds Transaction
```json
{"openapi":"3.0.1","info":{"title":"Funds Transfer API","version":"1"},"servers":[{"url":"https://sandbox.api.visa.com","description":"Sandbox server"}],"paths":{"/visadirect/fundstransfer/v1/multipushfundstransactions/{statusIdentifier}":{"get":{"tags":["Funds Transfer API"],"summary":"Read Multi Push Funds Transaction","description":"Read Multi Push Funds Transaction","operationId":"readMultiPushFundsTransaction","parameters":[{"name":"statusIdentifier","in":"path","description":"Status Identifier","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Multi Push Funds Transfer Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPushFundsTransactionGetResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MultiPushFundsTransactionGetResponse"}}}}}}}},"components":{"schemas":{"MultiPushFundsTransactionGetResponse":{"required":["actionCode","responseCode","retrievalReferenceNumber","statusIdentifier","transactionIdentifier","transmissionDateTime"],"type":"object","properties":{"actionCode":{"type":"string","description":"The results of the transaction request
Refer to Action Code
Note: : The VisaNet Response Code for the transaction"},"last4ofPAN":{"type":"integer","description":"This field contains the last four digits of the cardholder primary account number (PAN)"},"approvalCode":{"type":"string","description":"The authorization code from the issuer."},"responseCode":{"type":"string","description":"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"},"prepaidBalance":{"type":"string","description":"Min Inclusive: -999999999.999
Max Inclusive: 999999999.999
Applicable only for Top Up Transactions"},"settlementFlags":{"required":["settlementResponsibilityFlag"],"type":"object","properties":{"givUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementServiceFlag":{"type":"string","description":"Possible values are:
0 - International Settlement
9 - VIP to decide
8 - National Settlement
"},"givPreviouslyUpdatedFlag":{"type":"string","description":"Possible values are true or false"},"settlementResponsibilityFlag":{"type":"string","description":"Possible values are true or false"}},"description":""},"statusIdentifier":{"type":"string","description":"required when call times out"},"originalActionCode":{"maxLength":2,"minLength":2,"type":"string","description":"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."},"feeProgramIndicator":{"type":"string"},"transmissionDateTime":{"type":"string","description":"Example: 2016-01-15T07:03:52.000Z","format":"date-time"},"transactionIdentifier":{"maximum":15,"minimum":15,"type":"integer","description":"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.","format":"int64"},"prepaidBalanceCurrency":{"type":"object","properties":{}},"enablerVerificationValue":{"type":"string","description":"This field is to allow the application of the interchange discount at the enabler level.","format":"binary"},"retrievalReferenceNumber":{"type":"string","description":"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."}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.xft.finance/idn/use-cases/visa-direct/funds-transfer-api.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.