# VisaNet Connect - Acceptance
\\
Start a Project](https://developer.visa.com/portal/#users/new) \\
API Overview](https://developer.visa.com/capabilities/visanet-connect-acceptance)
Search API Reference
- [Getting Started](https://developer.visa.com/capabilities/visanet-connect-acceptance/docs-getting-started)
- [Authentication Method](https://developer.visa.com/capabilities/visanet-connect-acceptance/docs-authentication)
- [How to Use VisaNet Connect - Acceptance APIs](https://developer.visa.com/capabilities/visanet-connect-acceptance/docs-how-to)
- [Error Codes](https://developer.visa.com/capabilities/visanet-connect-acceptance/docs-error-codes)
- [Product Terms](https://developer.visa.com/capabilities/visanet-connect-acceptance/product-terms)
- [Request & Response Codes](https://developer.visa.com/request_response_codes)
- API Reference
- Authorization API
- postVoid Authorizations with id v3
- postAuthorizations v3
- postVoid Authorizations without id v3
- Settlement Position Inquiry API
- getGet Settlement
[Download VisaNet Connect - Acceptance API Reference](blob:https://developer.visa.com/ec639472-1c60-48d1-9ff0-92abef1b436a)
# Authorization API
Visa Payments Processing API
## Void Authorizations with id v3 v3 - Latest
Used to void an "Authorizations" resource.
Request
##### path Parameters
| | |
| --- | --- |
| id
required | string \[ 15 .. 32 \] characters
Id used in path |
##### Request Body schema: application/json
Request data
| | |
| --- | --- |
| Body | object |
| | | |
| --- | --- |
| Envt
required | object |
| | | |
| --- | --- |
| Accptr | object |
| | | |
| --- | --- |
| AddtlCtctInf | string \[ 1 .. 255 \] characters
Contains acceptor additional contact information.
Example: "4155551234" |
| AddtlData | object |
| | | |
| --- | --- |
| Tp | string <= 98 characters
Sales Org Id
Example: "ISOid" |
| Val | string \[ 1 .. 11 \] characters
Sales Org Id
Example: "42999952606" | |
| AddtlId | string \[ 1 .. 8 \] characters
Unique identifier value assigned by Visa for each merchant included in the identification program
Example: "52014057" |
| AddtlIds | object |
| | | |
| --- | --- |
| Tp | string \[ 1 .. 26 \] characters
Contains the Additional data IDs like GtyMrchntData- Gateway Merchant Data descriptor, BusRegID- Acceptor Business Registration ID, MKTP- Marketplace ID, GATW- Gateway ID, SDWT- Staged Digital Wallet ID, RMPP- Ramp Provider ID. NOTE: Gateway Merchant Data is being moved to Body.Envt.Accptr.PrvtData.GtwyMrchntData; Acceptor Business Registration ID type is being moved to Body.Envt.Accptr.BizRegnIdTp.
Enum:"GtyMrchntData""BusRegID""MKTP""GATW""SDWT""RMPP"
Example: "GtyMrchntData" |
| Val | string \[ 1 .. 255 \] characters
Contains the Additional data value for Ids in the TP like GtyMrchntData- Gateway Merchant Data Bank ABA number, BusRegID- Acceptor Business Registration ID number. NOTE: Gateway Merchant Data is being moved to Body.Envt.Accptr.PrvtData.GtwyMrchntData; Acceptor Business Registration ID number is being moved to Body.Envt.Accptr.BizRegnId.
Example: "V070990024552" | |
| Adr | object |
| | | |
| --- | --- |
| AdrLine1 | string \[ 1 .. 99 \] characters
Contains merchant street address. |
| Ctry | string 2 characters
The 2-character, uppercase alpha code for the country where the customer transaction occurs
Example: "US" |
| CtrySubDvsnMjr | string 2 characters
The 2-character, card acceptor state or province code. For U.S. card acceptors: a 2-digit numeric state code defined by ANSI X3.38-1972 (revised 1977).For Canadian card acceptors: a 2-digit numeric province code.
Example: "48" |
| CtrySubDvsnMnr | string 3 characters
The 3-character, card acceptor county code. For a U.S. card acceptor, it contains a 3-digit numeric county code as defined in FIPS PUB 6.3, 1979 (Federal Information Processing Standards Publication-Counties and County Equivalents of the States of the United States). This subfield does not apply to Canadian transactions.
Example: "002" |
| PstlCd | string \[ 5 .. 9 \] characters
card acceptor postal or ZIP code. When present in a U.S. transaction, it contains the 5-digit or 9-digit ZIP Code (5-digit ZIP code plus 4-digit extension) for the location of the customer transaction. When present in a Canadian transaction, this subfield contains the 6- or 9-character alphanumeric postal code (the 9-character alphanumeric Canadian postal code is the 6-character alphanumeric postal code followed by three zeros). When it is present in a Brazilian transaction, this subfield contains the 8-character numeric postal code
Example: "78641" |
| TwnNm | string \[ 1 .. 13 \] characters
Card-present transactions: contains the location of the merchant outlet where the transaction took place. Card-not-present transactions: contains the merchant's customer service telephone number, the merchant's universal resource locator (URL) or internet/e-mail address. | |
| BizRegnId | string \[ 1 .. 35 \] characters
Contains acceptor business registration ID.
Example: "123456789" |
| BizRegnIdTp | string 2 characters
Contains type of Government Registration Number. 00 (Unspecified), 01 (Tax Registration Identification), 02 (National Identification), 03 (Company Registration Identification), 04 (Passport), 99 (Visa Default Value).
Enum:"00""01""02""03""04""99"
Example: "00" |
| CstmrSvc | string \[ 1 .. 13 \] characters
Card-present transactions: contains the location of the merchant outlet where the transaction took place. Card-not-present transactions: contains the merchant’s customer service telephone number, the merchant’s universal resource locator (URL) or internet/e-mail address. NOTE: CstmrSvc will be remapped to Acceptor Customer Service Phone Number in a future release.
Example: "14155552235" |
| FrgnRtlrInd | boolean
Identifies a foreign retailer under a marketplace. DEfault value is false
Example: false |
| Id | string \[ 1 .. 15 \] characters
This field contains an acquirer-assigned code identifying the card acceptor for the transaction. The code can represent a merchant, a merchant location, or a merchant location terminal. If the ID code is less than 15 positions, it must be left-justified and space-filled.
Example: "GCTstore" |
| LtdAccptnc | string 1 characters
Indicates merchant limited accpetance information for MasterCard One Credential Exclusion. |
| PaymentFacltId | string \[ 1 .. 11 \] characters
Payment Facilitator Identifier Identifies the marketplace or payment facilitator
Example: "52014057" |
| PhneNb | string <= 16 characters
Contains acceptor phone number.
Example: "4155551234" |
| PrtnrId | string <= 8 characters
Contains acceptor partner ID code. |
| ShrtNm | string \[ 1 .. 25 \] characters
Contains the name of the card acceptor (merchant)
Example: "ABC Supplies" |
| SpnsrdMrchnt | object |
| | | |
| --- | --- |
| Id | object |
| | | |
| --- | --- |
| Id | string \[ 1 .. 15 \] characters
Sub-merchant Identifier
Example: "520140578465770" | | |
| SvcLctn | object |
| | | |
| --- | --- |
| AdrLine1 | string \[ 1 .. 99 \] characters
Contains acceptor service location street address.
Example: "1000 Main Street" |
| Ctry | string 3 characters
Contains acceptor service location country code. |
| CtrySubDvsnMjr | string 3 characters
Contains acceptor service location state/province code. |
| PstlCd | string \[ 4 .. 10 \] characters
Contains acceptor service location postal code.
Example: "94105" |
| TwnNm | string \[ 1 .. 50 \] characters
Contains acceptor service location city name.
Example: "San Francisco" | |
| URL | string \[ 1 .. 255 \] characters
Contains acceptor URL address. | |
| Card | object |
| | | |
| --- | --- |
| CardPdctTp | string <= 2 characters
Contains a product ID.
Example: "G1" |
| CardPrtflIdr | string 6 characters
Contains a program identification number used with a product ID attribute
Example: "ABCD12" |
| CardSeqNb | string 4 characters
A number assigned to a card when two or more individual cards are associated with the same primary account number
Example: "0200" |
| SchmeId | string 2 characters
Contains the card scheme selected for the transaction 01(Visa), 02(Others)
Example: "01" |
| Trck1 | string <= 76 characters
the information encoded on Track 1 of the magnetic stripe, including field separators but excluding beginning and ending sentinels and LRC characters
Example: "B4000222357994675^CHARLES ^230420100558222222" |
| Trck2 | object |
| | | |
| --- | --- |
| HexBinryVal | string <= 37 characters
the information encoded on Track 2 of the magnetic stripe, including field separators but excluding beginning and ending sentinels and LRC characters
Example: "04000220130005421D230620100222222222" | | |
| Crdhldr | object |
| | | |
| --- | --- |
| CrdhldrNm | object |
| | | |
| --- | --- |
| GvnNm | string \[ 1 .. 35 \] characters
Contains the first name of account or entity.
Example: "John" |
| LastNm | string \[ 1 .. 35 \] characters
Contains the last name of account or entity.
Example: "Smith" |
| MddlNm | string \[ 1 .. 35 \] characters
Contains the middle name of account or entity.
Example: "Michael" | |
| CstmrDsgnt | string
Account Owner Type. Primary - 01, Secondary - 02
Enum:"Primary""Secondary"
Example: "Primary" |
| Id | object |
| | | |
| --- | --- |
| AssgnrAuthrty | object |
| | | |
| --- | --- |
| Ctry | string 3 characters
Contains the Alpha-3 ISO country code of the issuing country.
Example: "USA" | |
| IdCd | string 4 characters
Contains the Identification Type Code.
Example: "TXIN" |
| IdSubCd | string 2 characters
Contains the Identification Subtype Code. 0B-Business, 0I-Individual
Example: "0B" |
| IdVal | string \[ 1 .. 35 \] characters
Contains the Identification Value.
Example: "12345" | | |
| Termnl | object |
| | | |
| --- | --- |
| Cpblties | object |
| | | |
| --- | --- |
| CardRdngCpblty | string \[ 4 .. 12 \] characters
Contains a terminal entry capability indicator. Valid values: KEEN – Key entered (terminal is not used), MGST - Magnetic stripe read capability, OPTC – QR code, OCRR - OCR read capability, ICCY - 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, an ICCY should be used regardless of whether Visa Contactless is also supported, ICPY - contactless specification but cannot read a contact chip on a card. For Visa Contactless, an ICPY should be used only if Visa Contactless is supported and contact chip is not.
Enum:"MGST""KEEN""OPTC""OCRR""ICCY""ICPY"
Example: "MGST" |
| CrdhldrVrfctnCpblty | object |
| | | |
| --- | --- |
| Cpblty | string 4 characters
Contains a PIN entry capability indicator used to indicate whether or not this terminal can accept online PINs. UNSP – Unknown. NPIN – Indicates terminal can accept and forward online PINs. NOOP – Indicates terminal cannot accept and forward online PINs.
Enum:"UNSP""NPIN""NOOP"
Example: "NOOP" | |
| PINLngthCpblties | string 2 characters
Maximum number of PIN characters that can be accepted by the point-of-service device
Example: "05" | |
| SubTp | string 1 characters
Account Entry Device Type |
| TermnlId | object |
| | | |
| --- | --- |
| Id | string <= 8 characters
This field contains a code that identifies a terminal at the card acceptor location, by itself or in conjunction with Card Acceptor Identification Code, when the value is not unique to a terminal. An identification code of fewer than 8 positions must be left-justified and the remainder of the field space-filled
Example: "VGCTapi1" | |
| Tp | string <= 4 characters
This field containt code to identifies the basic POS electronic terminal type. MPOS (Use to identify that an mPOS device is used to originate a transaction on an open network)
Example: "MPOS" | | |
| AdddmData | object |
| | | |
| --- | --- |
| AddtlAccptrData | object |
| | | |
| --- | --- |
| TxRegnId | string <= 20 characters
Merchant VAT Registration/ Single Business Reference Number
Example: "123456789a123456789a" | |
| AddtlData | object |
| | | |
| --- | --- |
| Tp | string
PlanRegSysId - Contains the plan registration system identifier value to identify the transaction as a Visa Installment Solutions transaction. This identifier is a ten-character alphanumeric unique value. Or HostBsdPrchRstrctn - Allows issuer to apply restrictions to the purchase. Response value must be included in the completion advice.
Enum:"PlanRegSysId""HostBsdPrchRstrctn"
Example: "PlanRegSysId" |
| Val | string \[ 1 .. 35 \] characters
Plan Registration System Identifier or Value for Host-Based Purchase Restrictions. This response value must be included in the complete advice request for Host-Based Purchase Restrictions
Example: "ABCD123456" | |
| Cstmr | object |
| | | |
| --- | --- |
| RefNb | string <= 17 characters
Customer Reference Number. The value may be a reference number, code, or generic number. Fuel transactions are identified by an MCC value of 5541 or 5542. In online transactions destined to an issuer, V.I.P. inserts Tag 1A and populates it with the customer code or reference identifier supplied by the acquirer in field 48, usage 36. Hence, fields 104 and 48 are present.
Example: "123456789asfhjkiu" |
| TxRegnId | string <= 13 characters
Customer VAT Registration Number
Example: "123456789adsq" | |
| Fleet | object |
| | | |
| --- | --- |
| LineItm | Array of objects
A separate line item should be added to the array for each fuel, non-fuel, and expanded non-fuel product included in the transaction. The array can accept up to 1 fuel type, 8 non-fuel types, and 4 expanded non-fuel types, for a maximum of 13 line items within the array. |
| Array
| | |
| --- | --- |
| EFleetPdctCd | string 4 characters
Expanded non-fuel type. Contains the purchased expanded non-fuel product code
Example: "1A01" |
| EvChargInd | string \[ 4 .. 5 \] characters
Electric Vehicle Charging Indicator. This indicator should be included in every instance of LineItm that has EV fields
Enum:"true""false"
Example: "true" |
| EvSpecific | Array of objects |
| Array
| | |
| --- | --- |
| Tp | string 4 characters
Ev Specific type. TtlTm(Total Time), TtlChrgTm(Total Changing Time), StrtTm(Start Time), EndTm(End Time), PwrCpcty(Charging Power Output Capacity), ChrgRsnCode(Charging Reason Code), EstmAdd(Estimated Km/Miles Added), CrbnFtprnt(Carbon Footprint), EstmAvlb(Estimated vehicle km/miles available), MaxPwrDspnsd(Maximum Power Dispensed), ConnTp(Connector Type)
Enum:"TtlTm""TtlChrgTm""StrtTm""EndTm""PwrCpcty""ChrgRsnCode""EstmAdd""CrbnFtprnt""EstmAvlb""MaxPwrDspnsd""ConnTp"
Example: "EstmAdd" |
| Val | string \[ 1 .. 12 \] characters
Value for the Ev Specific type given in Tp
Example: "100.00" | |
| FleetPdctCd | string \[ 2 .. 4 \] characters
Fuel or non-fuel product code. Fuel type codes are listed in Base II Clearing Data Codes document.
Example: "1A" |
| FuelBrndCd | string 4 characters
Fuel Brand
Example: "CIRK" |
| FuelInd | string \[ 4 .. 5 \] characters
Fuel indicator. This indicator should be included in each line item and describe if the product code for the line item is fuel (“FuelInd” = “true”), non-fuel (“FuelInd” = “false”), or expanded non-fuel (“FuelInd” = “false”)
Enum:"true""false"
Example: "true" |
| PdctQty | string 12 characters
Quantity of fuel, non-fuel, or expanded non-fuel product purchased. Three Decimal Places are implied.
Example: "25" |
| SvcTp | string 4 characters
Service Type. FLSV(Full service), SLSV(Self service)
Enum:"FLSV""SLSV"
Example: "FLSV" |
| UnitCost | Array of objects |
| Array
| | |
| --- | --- |
| Tp | string 4 characters
Unit Cost type. UNPC(Unit Cost), GRFP(Gross Fuel Price), NTFP(Net Fuel Price), GNFP(Gross Non-Fuel Price), NFFP(Net Non-Fuel Price)
Enum:"UNPC""GRFP""NTFP""GNFP""NFFP"
Example: "UNPC" |
| Val | string \[ 1 .. 12 \] characters
Value for the type of Unit Cost given in Tp. Three Decimal places are implied except for NFFP where two decimal places are implied
Example: "100.00" | |
| UnitOfMeasr | string 4 characters
Unit of Measure. LITR(Liter), USGA(U.S. gallon), GBGA(Imperial gallon), KILO(Kilo), PUND(Pound), CHMT(Charging minutes), KWHO(Kilowatt per hour)
Enum:"LITR""USGA""GBGA""KILO""PUND""CHMT""KWHO"
Example: "LITR" | |
| Summry | object |
| | | |
| --- | --- |
| AgtFuelPrmptCd1 | string \[ 1 .. 20 \] characters
Fleet Additional Prompted Data 1. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
Example: "123456789kiikjhasjk1" |
| AgtFuelPrmptCd2 | string \[ 1 .. 20 \] characters
Fleet Additional Prompted Data 2. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
Example: "123456789kiikjhasjk1" |
| Drvr | object |
| | | |
| --- | --- |
| Id | string <= 20 characters
Driver Identification
Example: "123456789adhjbnhyui1" |
| MplyeeId | string <= 12 characters
Fleet Employee Number. Contains the Visa Fleet cardholder employee number.
Example: "1234r4r4r456" | |
| TripInf | object |
| | | |
| --- | --- |
| JobNb | string <= 10 characters
Job Number
Example: "123456789y" | |
| TxRltdData | object |
| | | |
| --- | --- |
| PurchsTp | string <= 4 characters
Type of Purchase FUEL(Fuel purchase), NONF(Non-Fuel purchase), FANF(Fuel and Non-Fuel purchase)
Enum:"FUEL""NONF""FANF"
Example: "FUEL" |
| SummryCmmdtyId | string <= 4 characters
Summary Commodity Code
Example: "1234" |
| Tax | Array of objects |
| Array
| | |
| --- | --- |
| Amt | string <= 12 characters
Tax Amount. Two decimal places are implied. Only applicable to “Tp” values “LOCI”, “NATI”, and “OTHR”
Example: "100.00" |
| InclInTtlInd | string <= 5 characters
Indicator for whether the tax “Tp” is included in the total amount. Only applicable to the “Tp” values “LOCL” and “NATI
Enum:"true""false"
Example: "true" |
| Rate | string <= 4 characters
Tax Rate. Two decimal places are implied. Only applicable to “Tp” values “VATA” and “OTHR
Example: "1.00" |
| Tp | string <= 4 characters
Type of tax included in this purchase. LOCL(Local Tax), NATI(National Tax), VATA(VAT Tax rate), OTHR(Other Tax)
Enum:"LOCL""NATI""VATA""OTHR"
Example: "LOCL" | |
| TaxTtl | object |
| | | |
| --- | --- |
| TaxXmptn | boolean
Miscellaneous Fuel Tax Exemption Status. true(Exempt), false(Non-exempt)
Example: false | | |
| Vhcl | object |
| | | |
| --- | --- |
| FleetNb | string <= 8 characters
Fleet Number
Example: "1234567h" |
| Odmtr | string <= 7 characters
Odometer Reading
Example: "120" |
| TrlrNb | string <= 16 characters
Fleet Trailer Number. Contains the trailer number for the Visa Fleet cardholder or vehicle-assigned card.
Example: "123456789iururei" |
| VhclIdNb | string <= 14 characters
Vehicle Registration Number
Example: "123456789asdfg" | | | |
| Instlmt | object |
| | | |
| --- | --- |
| Plan | Array of objects |
| Array
| | |
| --- | --- |
| AnnlIntrstRate | string \[ 1 .. 8 \] characters
Annual Interest Rate
Example: "4" |
| AnnlTtlCostFin | string \[ 1 .. 8 \] characters
Annual Total Cost of Financing
Example: "4" |
| FrstPmtDt | string 6 characters
Date of First Installment YYMMDD
Example: "230421" |
| GracePrd | string 2 characters
Grace Period. Contains number of months from 00-99 that the payment is not required.
Example: "02" |
| GrdTtlAmt | string \[ 1 .. 13 \] characters
Total amount of the instalment including charges, insurance, and taxes in addition to the funded amount. The total amount cannot exceed USD$500,000.00
Example: "20000.23" |
| InstlmtCcy | string 3 characters
Currency code associated with the instalment amount. ISO 4217 "Codes for the representation of currencies and funds".
Example: "840" |
| InstlmtIntrst | string \[ 1 .. 13 \] characters
Installment Payment Interest
Example: "0.13" |
| InstlmtPmtTp | string
Installment Payment Type
Enum:"0""1""2""3"
Example: "1" |
| MnthIntrstRate | string \[ 1 .. 8 \] characters
Monthly Interest Rates
Example: "6" |
| NbOfPrds | string
Number of Periods
Enum:"1""2""4"".5"
Example: "1" |
| PctAmtReq | string \[ 1 .. 4 \] characters
Percent of Amount Requested.
Example: "13" |
| PctTtlExpnss | string \[ 1 .. 4 \] characters
Percent of Total Expenses
Example: "3" |
| PctTtlFees | string \[ 1 .. 4 \] characters
Percent of Total Fees
Example: "4" |
| PctTtlInsrnc | string \[ 1 .. 4 \] characters
Percent of Total Insurance
Example: "4" |
| PctTtlOtherCost | string \[ 1 .. 4 \] characters
Percent of Total Other Costs
Example: "3" |
| PctTtlTax | string \[ 1 .. 4 \] characters
Percent of Total taxes
Example: "4" |
| PlanOwnr | string 4 characters
Installment plan owner. ISSR = 01, ACCP = 03
Enum:"ISSR""ACCP"
Example: "ISSR" |
| PrdUnit | string
Period unit between consecutive payments
Enum:"YEAR""MNTH""QURT""WEEK""MIAN"
Example: "WEEK" |
| SbsqntAmt | string \[ 1 .. 13 \] characters
Approximate Amount of each Installment
Example: "6500.00" |
| TtlAmtFund | string \[ 1 .. 13 \] characters
Total Amount Funded
Example: "23.00" |
| TtlExpnss | string \[ 1 .. 13 \] characters
Total Expenses
Example: "23.00" |
| TtlFees | string \[ 1 .. 13 \] characters
Total Fees
Example: "20.00" |
| TtlInsrnc | string \[ 1 .. 13 \] characters
Total Insurance
Example: "10.00" |
| TtlNbOfPmts | string \[ 1 .. 4 \] characters
Total number of installment payments.
Example: "50" |
| TtlOthrCost | string \[ 1 .. 13 \] characters
Total Other Costs
Example: "8.00" |
| TtlTax | string \[ 1 .. 13 \] characters
Total Taxes
Example: "10.00" |
| VATInstlmtIntrst | string \[ 1 .. 8 \] characters
VAT for Installment Payment Interest. Vat calculated by acquirer for interest applicable to the transaction.
Example: "5.13" | |
| PmtSeqNb | string \[ 1 .. 2 \] characters
Payment Sequence Number
Example: "20" | |
| Ldgg | object |
| | | |
| --- | --- |
| LdggLineItm | Array of objects |
| Array
| | |
| --- | --- |
| OthrTp | string <= 4 characters
Contains prepaid expenses, food or beverage, folio cash advances being billed.
Enum:"PRPD""FDBV""FCAA"
Example: "PRPD" |
| Tp | string <= 4 characters
Provides detailed information about lodging accommodations and related expenses for the cardholder. Acquirers can submit multiple occurrences of this component for each lodging transaction to provide details of one or more folios. Valid Values are: 2(Restaurant or Room Service)=\[REST\] Restaurant, 3(Gift Shop)=\[GIFT\] Gift Shop, 4(Mini-Bar)=\[MINI\] Mini Bar, 5(Telephone)=\[PHON\] Phone, 6(Other) \[OTHR\] Other, 7(Laundry)=\[LAUN\] Laundry
Enum:"REST""GIFT""MINI""PHON""OTHR""LAUN""OTHP"
Example: "OTHP" |
| Val | string <= 4 characters
Contains amount, No decimal points should be used. Two decimal places are implied.
Example: "1234" | |
| Summry | object |
| | | |
| --- | --- |
| Arrvl | object |
| | | |
| --- | --- |
| Dt | string 6 characters
Date the customer checked into the hotel, in the format YYMMDD. For an advance lodging deposits and “no shows,” the lodging check-in date is the anticipated check-in date.
Example: "240618" | |
| Drtn | string <= 2 characters
For Rental it contains duration of rental in days.
Example: "01" |
| NoShowInd | integer
For Lodging Rental No Show Indicator indicates that the cardholder failed to show up and was therefore charged a no-show fee. The room was not actually rented.
Example: 1 |
| RoomNite | string <= 2 characters
Contains the total number of nights being billed.
Example: "01" |
| RoomRt | string <= 12 characters
Contains the daily rate being charged for the room. No decimal points should be used. Two decimal places are implied.
Example: "2000" |
| TtlRoomTax | string <= 12 characters
Contains the room tax that is being billed. No decimal points should be used. Two decimal places are implied.
Example: "1000" |
| TtlTax | string <= 12 characters
Contains the tax portion of the amount that is being billed for the room. No decimal points should be used. Two decimal places are implied.
Example: "1000" | | |
| PssngrTrnsprt | object |
| | | |
| --- | --- |
| Summry | object |
| | | |
| --- | --- |
| CdtRsnCd | string <= 1 characters
Contains a code that indicates the reason for a credit to the cardholder.
Example: "A" |
| Dprture | object |
| | | |
| --- | --- |
| Dt | string <= 6 characters
This value is the date of departure in mmddyy format.
Example: "062524" |
| Lctn | string <= 3 characters
3 character IATA airport code for the original departure location.
Example: "ATL" | |
| Pssngr | object |
| | | |
| --- | --- |
| Nm | string <= 20 characters
This 20-character subfield contains the passenger's name and is left-justified. Right space-fill is required.
Example: "John Smith" | |
| ResSys | string 4 characters
Contains a code that indicates the computerized reservation system used to make the reservation and purchase the ticket.
Example: "DATS" |
| Tckt | object |
| | | |
| --- | --- |
| ChngInd | string <= 1 characters
Contains a code that indicates why a ticket was changed.
Example: "N" |
| RstrctdTcktInd | string <= 1 characters
This subfield is used to indicate the purchase of a nonrefundable ticket. It is a conditional subfield for passenger transport transactions.
Example: "1" | | |
| TripLeg | Array of objects |
| Array
| | |
| --- | --- |
| AddtlData | string <= 3 characters
Miscellaneous information. This tag will either represent the IATA arrival airport code, or a three-character miscellaneous charge. Miscellaneous charges can be found in Table 85 of the SMS Full Service POS Online Messages Technical Specifications document.
Enum:"XUP""XAF""XCA""XOT""XDF""XAE""XAO""XAA""XTD""XPC""XPE"
Example: "XUP" |
| Crrier | string <= 2 characters
2 character IATA airliner carrier code.
Example: "DL" |
| FareBsisCd | string <= 6 characters
Contains a code that indicates the fare basis for the each leg of the trip
Example: "E" |
| RouteNb | string <= 5 characters
Contains the number of the airline flight to be taken on the each leg of the trip.
Example: "12345" |
| SeqNb | string <= 1 characters
Trip leg sequence number
Enum:"1""2""3""4"
Example: "1" |
| StopOverInd | string
Stop over indicator. space or O - Stop-over allowed, X No stop-over allowed
Enum:"X"" ""O"
Example: "X" |
| SvcClss | string <= 1 characters
Service class code.
Example: "Y" | | |
| PurchsIdr | string <= 25 characters
Identifies the purchase to the issuer and cardholder such as order number for card not present transactions
Example: "0123-23" |
| PurchsIdrTp | string <= 30 characters
Purchase identifier type. Purchase identifier type is required in the U.S. Valid values: “ORNU” (Order number), “REAG” (Rental agreement),“FONU” (Folio number)
Enum:"ORNU""REAG""FONU"
Example: "ORNU" |
| RcrngPmt | object |
| | | |
| --- | --- |
| Frqcy | string 4 characters
Frequency of Recurring Payment. DAIL(daily), TWWK(twice weekly), WEEK(weekly), TEND(ten days), FRTN(fortnightly), MNTH(monthly), BIMN(every two months), TMTR(trimester), QURT(quarterly), MIAN(twice yearly), YEAR(annually),ADHO(unscheduled)
Enum:"DAIL""TWWK""WEEK""TEND""FRTN""MNTH""BIMN""TMTR""QURT""MIAN""YEAR""ADHO"
Example: "DAIL" |
| MaxAmt | string \[ 1 .. 12 \] characters
Maximum amount agreed to by the cardholder. Amount will be specified in F49 currency(Currency Code, Transaction)
Example: "100.00" |
| NbOfPmt | string 2 characters
Number of Recurring Payment. 01-99 – Helps the issuer to identify total number of recurring debits for that cardholder as agreed with merchant. Value of 99 means that recurring payments are authorized until canceled or that the Number of Recurring Payments is not defined.
Example: "01" |
| PerTxAmtTp | string 1 characters
Payment Amount Indicator Per Transaction. 1(Fixed amount Recurring Payment), 2(Recurring Payment with maximum amount)
Enum:"1""2"
Example: "1" |
| RegnRefNb | string \[ 10 .. 35 \] characters
Registration Reference Number. Contains unique reference number for recurring payment transactions. This number is generated before the recurring payment registration. It is required at the time of registration transaction and in every subsequent transaction.
Example: "123456789A123456789A123456789A12345" |
| Tp | string 1 characters
Recurring Payment Type. 1(Registration/first transaction), 2(Subsequent transaction), 3(Modification), 4(Cancellation)
Enum:"1""2""3""4"
Example: "1" |
| ValInd | string 1 characters
Validation Indictor. Offline validation between Acquirer and Issuer during registration: false(not validated), true(validated)
Enum:"true""false"
Example: "true" | |
| TrvlAgcy | object |
| | | |
| --- | --- |
| Cpny | object |
| | | |
| --- | --- |
| Cd | string <= 8 characters
A code that represents the travel agency used during booking, if applicable.
Example: "12345678" |
| Nm | string <= 25 characters
The name of the travel agency used during booking, if applicable.
Example: "Travel Agency" | | |
| VhclRntl | object |
| | | |
| --- | --- |
| RntlAgrmt | object |
| | | |
| --- | --- |
| CtctNm | string <= 40 characters
Contains the name of renter.
Example: "John Smith" |
| DailyRate | string <= 12 characters
Contains the daily rate being charged for the vehicle
Example: "20.00" |
| InsrncAmt | string <= 12 characters
Contains insurance being charged for the vehicle.
Example: "200.00" |
| VhclClss | string <= 2 characters
Contains a code indicating the type of vehicle.
Example: "01" |
| WeeklyRate | string <= 12 characters
Contains the weekly rate being charged for the vehicle.
Example: "14.00" | |
| RntlInvc | object |
| | | |
| --- | --- |
| ChckOutDt | string 8 characters
Check Out Date (CCYYMMDD) contains the date the vehicle was picked-up by the customer. In the case of a no-show transaction or a prepaid transaction, this contains the scheduled pickup date.
Example: "20200723" |
| DpofChrg | string <= 12 characters
Contains charges for one-way drop-off of the vehicle.
Example: "123456789" |
| FuelChrg | string <= 12 characters
Contains fuel being charged for the vehicle.
Example: "123456" |
| NoShowInd | integer
For Vehicle Rental No Show Indicator indicates that the cardholder failed to pick up the vehicle and was therefore charged a no-show fee. The vehicle was not actually rented
Example: 1 |
| Tp | Array of objects
Example: \["FUEL","LATE"\] |
| Array
| | |
| --- | --- |
| Tp | string <= 4 characters
Extra charges for auto rentals. FUEL - Gasoline (1), EXDI - Extra Mileage (2), LATE - Late Return (3), ONEW - Drop Off Charge (4), FINE - Parking or Moving Violation (5)
Enum:"FUEL""EXDI""LATE""ONEW""FINE"
Example: "FUEL" | |
| TtlDrtn | string <= 2 characters
Contains the total number of days that the vehicle was rented
Example: "04" | | | |
| Cntxt | object |
| | | |
| --- | --- |
| PtOfSvcCntxt | object |
| | | |
| --- | --- |
| AddtlData | object |
| | | |
| --- | --- |
| Tp | string <= 14 characters
Purchase Restriction Flag. Allows merchants to indicate POS terminal can support card restrictions
Value:"PrchRstrctnInd"
Example: "PrchRstrctnInd" |
| Val | string 1 characters
Contains card restriction value. Valid values: “0” – false, “1” – true
Example: "1" | |
| AttnddInd | boolean
Used to indicate if the card acceptor’s representative is in attendance during the transaction. Semi-attended terminals (e.g., multiple terminals supervised by a single clerk) is considered attended.
Example: true |
| CardDataNtryMd | string <= 4 characters
Contains a card data entry method value which is used to indicate card reading capabilities of the terminal performing the transaction. Valid values: KEEN – Key entered, MGST – Magnetic stripe read and exact content of Track 1 or Track 2 included (CVV check may or may not be possible), OPTC – Optical code (e.g., barcode, QR code), ICCY – Contact integrated circuit card read using VSDC chip data rules; Online CAM authentication method; iCVV checking may or may not be possible, ICPY – Contactless device-read-originated using qVSDC chip data rules; Online CAM authentication method; iCVV checking possible, MSIP - Contactless device-read-originated using magnetic stripe data rules; dCVV checking is possible; Online CAM checking possible for MSD CVN 17 only. CDFL - Credential on file
Enum:"UNSP""KEEN""MGST""OPTC""ICCY""ICPY""MSIP""CDFL"
Example: "KEEN" |
| CardPres | boolean
Card Present
Example: true |
| CrdhldrActvtd | boolean
Contains an unattended cardholder activated environment indicator which indicates whether the automated device was operated solely by the cardholder or not (e.g., vending machine, automated fuel dispenser, ATM, kiosk, etc.)
Example: false |
| CrdhldrPres | boolean
Card Holder Present
Example: true |
| EComrcInd | boolean
Contains a Point-of-Service indicator which is used to indicate whether a transaction originated at the point of service or it’s a E-commerce request.
Example: false |
| MOTOInd | boolean
Mail/Phone (MOTO) Boolean indicator distinguishing the type of mail or telephone order
Example: true |
| SpclConds | Array of objects |
| Array
| | |
| --- | --- |
| Id | string <= 30 characters
Request from Merchant for Updated Account.
Example: "NewPANRequested" | | |
| SaleCntxt | object |
| | | |
| --- | --- |
| GoodsAndSvcsSubTp | string <= 4 characters
Possible Value - CRCU: Cryptocurrency purchase
Value:"CRCU"
Example: "CRCU" |
| GoodsAndSvcsTp | string <= 4 characters
Specifies the type of goods and/or services sold. Possible values are: ELEC (Electronic goods and services), PHYS (Physical goods or services)
Enum:"ELEC""PHYS"
Example: "ELEC" | |
| TxCntxt | object |
| | | |
| --- | --- |
| AuthntcnOutgInd | boolean
SCA Outage Indicator
Example: true |
| CaptrDt | string 4 characters
Capture Date in the format MMDD
Example: "0421" |
| CardPrgrmm | object |
| | | |
| --- | --- |
| CardPrgrmmApld | object |
| | | |
| --- | --- |
| Id | string 4 characters
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. All Network ID Codes can be found in 63.1 of the SMS Full Service POS Online Technical Specifications.
Example: "0002" | | |
| ICCFllbckInd | string <= 1 characters
Chip Condition Code
Example: "0" |
| MgntcStrpFllbckInd | boolean
Magnetic Strip Fallback Indicator
Example: true |
| MrchntCtgyCd | integer \[ 1 .. 9999 \]
4-digit Merchant Category Code (ISO 18245)
Example: 4814 |
| MrchntCtgySpcfcData | string 1 characters
Market-Specific Data Identifier
Example: "B" |
| MrchntVolInd | string <= 2 characters
Merchant Volume Indicator. The only allowed value for this tag is '01'. The request value will override what is in the profile.
Example: "01" |
| PINPadInprtv | boolean
Contains a PIN Pad indicator which is used to indicate whether or not the PIN pad is operative.
Example: false | |
| Vrfctn | Array of objects
Example: \[{"Tp":"ADDB","VrfctnInf":{"Val":{"TxtVal":"PO Box 12345"}}},{"Tp":"PCDV","VrfctnInf":{"Val":{"TxtVal":"12345"}}},{"Tp":"CSCV","VrfctnInf":{"Val":{"TxtVal":"321"}}},{"Tp":"THDS","VrfctnInf":{"Tp":"authenticationValue","Val":{"HexBinryVal":"099010618111100000000788400707000000000"}}}\] |
| Array
| | |
| --- | --- |
| Tp | string <= 4 characters
Type of verification requested. Valid values: Card authentication results code, THDS – 3D Secure, ADDB – Billing address verification, PCDV – Postal code, CSCV – CSC verification
Enum:"THDS""ADDB""PCDV""CSCV"
Example: "THDS" |
| VrfctnInf | object |
| | | |
| --- | --- |
| Rsn | string \[ 1 .. 35 \] characters
Value for CSCV Value not entered
Enum:"Illegible""NotAttempted""NotOnCard" |
| Tp | string
Tp value for verification. Possible value is authenticationValue (3DS (3D Secure)) authentication performed during a secure electronic commerce transaction)
Example: "authenticationValue" |
| Val | object |
| | | |
| --- | --- |
| HexBinryVal | string 40 characters
Cardholder Authentication Verification Value. (THDS/3DS)
Example: "0000010679579169514231801557910000000000" |
| PINData | object
Security Related Control Information |
| | | |
| --- | --- |
| Algo | string <= 2 characters
Algorithm ID
Example: "01" |
| KeyIndx | string <= 2 characters
Zone Key Index
Example: "01" |
| PINBlckFrmt | string <= 2 characters
PIN Block Format
Example: "01" | |
| TxtVal | string \[ 1 .. 40 \] characters
Value for ADDB, PCDV, CSCV, DRIV, PASN, NTID, TXIN Validation | | | | |
| GatewayData | object |
| | | |
| --- | --- |
| AddtnlData | Array of objects |
| Array
| | |
| --- | --- |
| Tp | string
Mastercard, Amex, Discover/Diners Gateway data. Please reference the VPP release notes for a list of all Tp and Val pairs
Enum:"ClientDefinedData""AuthID""PymtIntCnl""PrmtnCd""AddtlNtnldata""MAMID""TransitProgram""GrttyAmt""FnlAuthInd""ChpTermInd""ChpPreVld""ECISctyLvlId""POSTermLoc""AcqrSctySvcData""TermnlCmplntInd""MblRmtPmtTxTp""PymntFcId""ISOId""MrchntId""AthntctnSvc""PanNtryMd""TknAssrncMtd""TknRqstrId""TxIntgrty""PAUT""EMSScoreRqst""EMSFrdScore""TxSubTp""AcctTpInd""MAAddtlRspnData""EIdRqst""MPOS""MA3DSData""LowRskMrchtInd""SnglTapInd""RspnToPINRqst""IssRqstPINInd""MAICA""DSRP""RmotCmrcMrchtIdr""MrchtHmCntry""MCALMSvcData""MerchtAdvcCd""CITMIDInd""PrchAmtOnlyInd""SndrRefNm""SspctFrd""CanadaDmstcInd""WlltId""RcptFrTxt""PrpdActLd""AcctNbInd""MCPOSNtryCd""MCPOSPINCaptrCd""MCPOSData""MCAuthDtTm""MCECI""AmexInstlemt""PhneNb""Email""CrdPresGdsSld""AppInitdPmtTkn""PANdata""ReturnedPANData""NmAndLctn""TxInitr""PmtAcctRef""AuthntcnOutgInd""UCOF""TknECI""SellerID""Lst4PANReqInd""AmxPOSDataCd""DscvrRNtwkInf""DscvrTxQlf""OTHP""UCAFColltnInd""UCAFData""MrchntPmtID""Adr""URL""CstmrSvc""AccptrPhneNb""AddtlCtctInf""TaxID""PrtnrIDCode""CtyNm"
Example: "MAICA" |
| Val | string
Mastercard, Amex, Discover/Diners Gateway data values. Please reference the VPP release notes for a list of all Tp and Val pairs
Example: "008376" | |
| GatewayBrand | string 3 characters
Contains a Brand for GatewayData processing. Valid values: Mastercard - MSC, American Express - AMX, Discover - DSC
Enum:"MSC""AMX""DSC"
Example: "MSC" | |
| ICCRltdData | string <= 255 characters
Contains integrated circuit card (ICC)-related data that is transmitted from the ICC to the card issuer and from the card issuer to the ICC. This field supports both usage 1 (VSDC chip data) and usage 2 (chip card data).
Example: "01007B9F02060000000163339F2608B9E652BBD8FE30E54F07A00000009808409F0607A0000000980840820218009F360201519F34034200009F2701809F3303E0F8C89F1A0208409F350122950580000480005F2A0200009A032206079B0268009C01009F3704D28971EC8407A00000009808409F100706020A03A00000" |
| NtlData | object |
| | | |
| --- | --- |
| Ctry | string 3 characters
Contains a country code for jurisdictions participating in domestic processing.
Example: "032" |
| InstlmtPmtInd | string 2 characters
2-byte alphanumeric subfield contains installment payment indicator. Valid values: CO (Sale/Cash Disbursement).
Example: "CO" |
| InstlmtPmtIntrstSttlmInd | string 1 characters
1-byte mandatory subfield must contain A (add) or D (do not add) to indicate whether the installment payment interest risk fee amount and VAT for installment payment interest risk fee amount are to be disregarded or added to the IRF.
Enum:"A""D"
Example: "D" |
| InstlmtPmtNb | string 2 characters
2-byte numeric subfield can contain installment payment number from 01-99.
Example: "11" |
| IRFIndicator | string 1 characters
1-byte mandatory subfield must contain D (do not subtract) or S (subtract) to indicate whether the installment payment interest and VAT for installment payment interest amounts are to be added or subtracted from the national reimbursement fee (IRF).
Enum:"D""S"
Example: "D" |
| NbOfInstlmtPmts | string 2 characters
2-byte numeric subfield can contain number of installment payments from 01-99.
Example: "12" |
| VATRate | string 4 characters
4-byte subfield must contain a 4-digit VAT rate with two decimal places.
Example: "1.00" | |
| NtnlData | object |
| | | |
| --- | --- |
| AddtnlData | Array of objects |
| Array
| | |
| --- | --- |
| Tp | string
National Net Settlement Service data elements. Valid values: NATIRF = National Reimbursement Fee, NATMATYP = National Net Miscellaneous Amount Type, NATIRFBASE = National Net IRF Amount, NATMISCAMT = National Net Miscellaneous Amount, NATVATBASE = Amount Base of Value Add Tax to Return, NATCTAX = Consumption Tax Amount, NATVATAMT = Value Add Tax Amount, NATCTIND = Cost Transaction Indicator, NATCBRC = National Chargeback Reason Code, NATTOKENDT = National Net Domestic Token Data
Enum:"NATTOKENDT""NATIRF""NATMATYP""NATIRFBASE""NATMISCAMT""NATVATBASE""NATCTAX""NATVATAMT""NATCTIND""NATCBRC"
Example: "NATIRF" |
| Val | string
National Net Settlement Service data values. For Tp = NATIRF, Val = reimbursement fee. Must be expressed in the currency present in Body.Tx.TxAmts.TxAmt.Ccy. For Tp = NATMATYP, Val = A (Airport charge), C (Cashback), or T (Tip). For Tp = NATIRFBASE, Val = an amount greater than 0. For Tp = NATMISCAMT, Val = Amount of tip, cashback, or airport tax. For Tp = NATVATBASE, Val = base value of IVA (sales tax). For Tp = NATCTAX, Val = consumption tax amount. For Tp = NATVATAMT, Val = national government tax for added value. For Tp = NATCTIND, Val = 1 (Cost Inquiry Transaction). For Tp = NATCBRC, Val = 2-digit Visa chargeback reason code. For TP = NATTOKENDT, Val = optional supplementary private information for Colombia National Net Settlement Service
Example: "RQCH" | |
| CountryCd | string 3 characters
Contains a country code for jurisdictions participating in domestic processing.
Example: "170" |
| SpainData | Array of objects |
| Array
| | |
| --- | --- |
| LclAccptrId | string <= 15 characters
Contains Spanish merchant ID when it differs from the international merchant ID. |
| LclMrchntCtgyCd | string <= 4 characters
Contains the domestic MCC when it differs from the international MCC
Example: "6010" | | |
| SplmtryData | Array of objects |
| Array
| | |
| --- | --- |
| StrngCstmrAuthntcn | object |
| | | |
| --- | --- |
| DlgtdAuthrty | string <= 4 characters
Details regarding Delegated Authority - CLAI = Claimed
Example: "CLAI" |
| Xmptn | Array of objects
Example: \[{"Tp":"TMBE","Val":"CLAI"},{"Tp":"LOWA","Val":"CLAI"}\] |
| Array
| | |
| --- | --- |
| Tp | string <= 4 characters
Type of SCA (strong customer authentication) performed. Possible Values - TMBE-Trusted Merchant Beneficiary Exemption, LOWA-Low Value Exemption, TRAE-Transaction Risk Analysis Exemption, SCPE-Secure Corporate Payment Exemption.
Example: "TMBE" |
| Val | string <= 4 characters
Value associated with type of Strong Customer Authentication Type. Valid values in request: CLAI = Claimed
Example: "CLAI" | | | |
| Tx | object |
| | | |
| --- | --- |
| AcctFr | object |
| | | |
| --- | --- |
| AcctId | string <= 29 characters
Account Identification 1
Example: "0000305071" | |
| AddtlData | object |
| | | |
| --- | --- |
| Tp | string <= 36 characters
Free form description data for the transaction or Sharing Group Code
Enum:"FreeFormDescData""SharngGrpCd"
Example: "FreeFormDescData" |
| Val | string <= 98 characters
Free form description data for the transaction or Sharing Group Code. Valid values for Sharing Group Code: “C”(CU24), “E”(Accel), “F”(NYCE), “G”(Interlink), “H”(Pulse), “K”(EBTPOS), “L”(Pulse), “M”(Star), “N”(Star), “P”(NETS), “Q”(Star), “S”(Pulse), “U”(AFFN), “V”(Visa), “W”(Star), “Y”(NYCE), “Z”(Star), “3”(AlaskaOption), “7”(Shazam), “8”(Maestro)
Example: "freeformdata" | |
| AddtlSvc | object |
| | | |
| --- | --- |
| OthrTp | string <= 12 characters
Transaction ID Service Instruction. StoreTxId – Store transaction ID ,RetrieveTxId – Retrieve transaction ID ,StoreRetrieveTxId – Save/Retrieve
Enum:"StoreTxId""RetrieveTxId""StoreRetrieveTxId"
Example: "StoreTxId" |
| Tp | string <= 11 characters
Dynamic Currency Conversion Indicator or Other value
Enum:"DCCV""OTHP"
Example: "OTHP" | |
| AltrnMsgRsn | string <= 4 characters
States why the action was taken. Possible values include: 2501 - Transaction voided by customer, 2502 - Request timed out, 2503 - No confirmation from point of service, 2504 - Partial void (only valid for Authorization voids).
Example: "2501" |
| SpclPrgrmmQlfctn | object |
| | | |
| --- | --- |
| Dtls | Array of objects
Example: \[{"Nm":"ACI","Val":"Y"}\] |
| Array
| | |
| --- | --- |
| Nm | string <= 35 characters
Contains a special program detail request value. For “RmbrsmntAttr”, please view the VPP February 2023 release notes for all valid values. For “ACI”, valid values are “Y” – requests participation, “R” – recuring payment, “I” – increment to previously approved transaction, and “P” – preferred customer. For “ReqPmtSvc”, valid values can be found in field 62.15 of the Full Service POS Online Messages Technical Specifications document. For “MVV”, clients should send in a 10 digit MVV. Should the MVV be 6 digits, clients should zero-fill the remaining 4 spaces. For “SPEND”, valid values are “B” – base spend assessment has been met, “N” – spend assessment has not been met, and “Q” – qualified spend assessment has been met.
Enum:"ACI""ReqPmtSvc""MVV""SPEND""RmbrsmntAttr""EVV" |
| Val | string \[ 1 .. 10 \] characters
Contains a value “Val” for each “Tp” included in the array. Valid values: REGU – regulated account, NREG – non-regulated account. Valid values for RmbrsmntAttr: 0 - Chip Standard purchase and credit voucher transactions—Canada. Code U also applies to these transactions, 3 - EPS (Australia and New Zealand) and NSR(Canada), 4 - Supermarket Incentive Program (U.S. only), 5 - Electronic Commerce Fee, 7 - Electronic Data Capture(VE only). Not for Asia-Pacific region for original draft transactions.CNP and CVV2 fee programs(VE), 8 - PIN-authenticated Visa Debit, 9 - VPAY Large-Market Petrol (VE Only), B - Applies to:Interregional Electronic, CEMEA Intraregional Electronic, Asia-Pacific Electronic Reimbursement Fee, Canada Chip Fee(only in response), U.K. Card Not Present, U.K. Electronic Hot Card File, International Visa Electron Card, U.K. Airline Interim Interchange Reimbursement Fee VE, Electronic Online Authorized (EOA), Europe EMV Fee, C - Reserved, D - Reserved: Delta-only merchant standard Interchange Reimbursement Fee(U.K. only). CPS/Charity and Religious Organizations and CPS/Retail 2 Fee Programs with MCCs of 8398 (Charitable and Social Service Organizations) and 8661 (Religious Organizations) for specific merchants meeting program requirements(U.S. only), E - Reserved, F - Delta-only merchant Electronic Interchange Reimbursement Fee (U.K. only). Recurring Payment and Emerging Segment Recurring Payment Interchange Reimbursement Fee(Canada only), J - Electronic Interchange Reimbursement Fee (U.S. only). Chip Electronic purchase and credit voucher transactions (Canada only), K - Key-entered Payment Service Reimbursement Fee(U.S. only for select developing markets only), L - Reserved for future use: BASE II Draft data transactions only, M - Card not present Interchange Reimbursement Fee(Canada only), N-S - Reserved for future use: BASE II Draft data transactions only, T - Reserved, U - Emerging Segment Standard(Canada). Chip Standard purchase and credit voucher transactions(Canada). Code 0 also applies to these transactions. In addition, code 0 applies to Chip Standard transactions that request VPP fee programs. Chip Standard transactions that meet Emerging Segment Standard eligibility requirements and fee edit criteria must be submitted with code U., V - Reserved. Valid values for EVV: Any combination of Alphanumeric. No special characters. i.e '00000', '12345', 'ABC12'.
Example: "Y" | |
| Prgrmm | string <= 3 characters
Specifies the name of the special incentive program. Only Valid Value is CPS (Custom Payment Service)
Example: "CPS" | |
| TxAmts | object |
| | | |
| --- | --- |
| DtldAmt | Array of objects
Example: \[{"Tp":"SRCH","Amt":"100.00"},{"Tp":"CSHB","Amt":"200.00"}\] |
| Array
| | |
| --- | --- |
| Amt | string <= 8 characters
Additional transaction detail type amount for either surcharge or cashback
Example: "100.00" |
| CdtDbt | string <= 4 characters
This field is applicable and used to indicate if the surcharge is a debit or credit against the cardholder account. CRDT – credit , DBIT – debit(default value)
Enum:"CRDT""DBIT"
Example: "CRDT" |
| Tp | string
Additional transaction detail type or Healthcare auto-substantiation details. Valid Values:SRCH – Surcharge amount,CSHB – Purchase cashback amount, 4S - Total Amount Healthcare, 4V - Amount Vision/Optical, 4U - Amount Prescription/RX, 4W - Amount Clinic/Other Qualified Medical, 4X - Amount Dental, 3S - Amount co-payment, 4P - Additional Transaction Fee 1, 4Q - Additional Transaction Fee 2
Enum:"SRCH""CSHB""4S""4V""4U""4W""4X""3S""4P""4Q" | |
| TxAmt | object |
| | | |
| --- | --- |
| Amt | string <= 13 characters
Transaction amount with explicit decimal point to represent minor unit.
Example: "123.45" |
| Ccy | string \[ 2 .. 3 \] characters
Numeric currency code conforming to ISO 4217.
Example: "840" | | |
| TxAttr | Array of strings
Items Enum:"INST""RCPT""DBRP""UCOF""MOTO""DFRD""PAUT"
Example: \["RCPT"\] |
| TxId | object |
| | | |
| --- | --- |
| AssctdTxLifeCyclId | string 22 characters
Contains the Transaction Link Identifier from an economically related, independent transaction that a customer retains and returns in subsequent economically related transactions.
Example: "" |
| LclDtTm | string
Local date and time the transaction takes place at the card acceptor location. Format is ISO 8601 (YYYY-MM-DDThh:mm:ss)
Example: "2016-11-25T01:02:03" | |
| TxSubTp | string <= 35 characters
Business Application Identifier - CB Consumer Bill Payment
Example: "CB" | | |
| Hdr | object |
| | | |
| --- | --- |
| NttyId | string <= 6 characters
Entity ID used for station pairing during testing. This tag should only be included in the request message when testing in Visa's VCMS environment.
Example: "000003" |
| TracData | object |
| | | |
| --- | --- |
| TracData | object |
| | | |
| --- | --- |
| Tp | string <= 24 characters
Data that is returned unaltered in the response message.
Example: "AddtnlTraceData" |
| Val | string <= 24 characters
Data that is returned unaltered in the response message.
Example: "anyroundtripinfo" | | | |
| msgIdentfctn | object
Message identification and tracing elements. |
| | | |
| --- | --- |
| clientId | string <= 32 characters
Client Identification is a unique value assigned by Visa
Example: "1VISAGCT000001" |
| correlatnId | string <= 32 characters
correlatnId field must contain the same value as the original transaction being voided.
Example: "12bc567d90f23e56a8f012" | |
Responses
200
Success
##### Response Schema: application/json
| | |
| --- | --- |
| Body | object |
| | | |
| --- | --- |
| PrcgRslt
required | object |
| | | |
| --- | --- |
| ApprvlData | object |
| | | |
| --- | --- |
| ApprvlCd | string 6 characters
Authorization code from the issuer
Example: "529801" | |
| RsltData | object |
| | | |
| --- | --- |
| AddtlRsltInf | Array of objects |
| Array
| | |
| --- | --- |
| Tp | string <= 11 characters
Type of Additional Result. Possible Values: Dupl, AcctStatus, VAURsnCd
Example: "AcctStatus" |
| Val | string <= 6 characters
Additional transaction result information If Tp=Dupl, no value is required. If Tp=AcctStatus, Possible Values are Closed(C), Contact Cardholder(Q), Expiration Date Change(E), Account Number Change(A). If Tp=VauRsnCd, possible values are VAU001 (Transaction did not qualify for Real Time VAU because the transaction contains token),VAU002 (Real Time VAU is supported only for Visa-branded PAN),VAU003 (Real Time VAU is not supported for the network),VAU004 (Transaction is not original purchase, purchase return, bill payment, account funding, or original credit),VAU005 (Transaction contains CVV2),VAU007 (Real Time VAU is not supported for this MCC),VAU008 (Acquirer of processor is not activated for Real Time VAU),VAU009 (Issuer does not support Real Time VAU),VAU010 (Issuer or Visa blocked the merchant),VAU012 (Credentials in the authorization request is the latest VAU data),VAU013 (Expiry date in the authorization request is later than VAU data),VAU014 (PAN has been opted out of VAU),VAU015 (Transaction is a face-to-face transaction type),VAU016 (PAN has stop advice set up)
Example: "C" | |
| Rslt | string <= 17 characters
Transaction result.
Enum:"Processed""NotProcessed""Error" |
| RsltDtls | string 2 characters
Results of transaction request.
Example: "00" | | |
| AdddmData | object |
| | | |
| --- | --- |
| AddtlAccptrData | object |
| | | |
| --- | --- |
| TxRegnId | string <= 20 characters
Merchant VAT Registration/ Single Business Reference Number
Example: "123456789a123456789a" | |
| AddtlData | object |
| | | |
| --- | --- |
| Tp | string
PlanRegSysId - Contains the plan registration system identifier value to identify the transaction as a Visa Installment Solutions transaction. This identifier is a ten-character alphanumeric unique value. Or HostBsdPrchRstrctn - Allows issuer to apply restrictions to the purchase. Response value must be included in the completion advice.
Enum:"PlanRegSysId""HostBsdPrchRstrctn"
Example: "PlanRegSysId" |
| Val | string \[ 1 .. 35 \] characters
Plan Registration System Identifier or Value for Host-Based Purchase Restrictions. This response value must be included in the complete advice request for Host-Based Purchase Restrictions
Example: "ABCD123456" | |
| Cstmr | object |
| | | |
| --- | --- |
| RefNb | string <= 17 characters
Customer Reference Number. The value may be a reference number, code, or generic number. Fuel transactions are identified by an MCC value of 5541 or 5542. In online transactions destined to an issuer, V.I.P. inserts Tag 1A and populates it with the customer code or reference identifier supplied by the acquirer in field 48, usage 36. Hence, fields 104 and 48 are present.
Example: "123456789asfhjkiu" |
| TxRegnId | string <= 13 characters
Customer VAT Registration Number
Example: "123456789adsq" | |
| Fleet | object |
| | | |
| --- | --- |
| LineItm | Array of objects
A separate line item should be added to the array for each fuel, non-fuel, and expanded non-fuel product included in the transaction. The array can accept up to 1 fuel type, 8 non-fuel types, and 4 expanded non-fuel types, for a maximum of 13 line items within the array. |
| Array
| | |
| --- | --- |
| EFleetPdctCd | string 4 characters
Expanded non-fuel type. Contains the purchased expanded non-fuel product code
Example: "1A01" |
| FleetPdctCd | string \[ 2 .. 4 \] characters
Fuel or non-fuel product code. Fuel type codes are listed in Base II Clearing Data Codes document.
Example: "1A" |
| FuelBrndCd | string 4 characters
Fuel Brand
Example: "CIRK" |
| FuelInd | string \[ 4 .. 5 \] characters
Fuel indicator. This indicator should be included in each line item and describe if the product code for the line item is fuel (“FuelInd” = “true”), non-fuel (“FuelInd” = “false”), or expanded non-fuel (“FuelInd” = “false”)
Enum:"true""false"
Example: "true" |
| PdctQty | string 12 characters
Quantity of fuel, non-fuel, or expanded non-fuel product purchased. Three Decimal Places are implied.
Example: "25" |
| SvcTp | string 4 characters
Service Type. FLSV(Full service), SLSV(Self service)
Enum:"FLSV""SLSV"
Example: "FLSV" |
| UnitCost | Array of objects |
| Array
| | |
| --- | --- |
| GrdTtlAmt | string \[ 1 .. 13 \] characters
Total amount of the instalment including charges, insurance, and taxes in addition to the funded amount. The total amount cannot exceed USD$500,000.00
Example: "20000.23" |
| InstlmtCcy | string 3 characters
Currency code associated with the instalment amount. ISO 4217 "Codes for the representation of currencies and funds".
Example: "840" |
| NbOfPrds | string
Number of Periods
Enum:"1""2""4"".5"
Example: "1" |
| PlanOwnr | string 4 characters
Installment plan owner. ISSR = 01, ACCP = 03
Enum:"ISSR""ACCP"
Example: "ISSR" |
| PrdUnit | string
Period unit between consecutive payments
Enum:"YEAR""MNTH""QURT""WEEK""MIAN"
Example: "WEEK" |
| SbsqntAmt | string \[ 1 .. 13 \] characters
Approximate Amount of each Installment
Example: "6500.00" |
| TtlNbOfPmts | string \[ 1 .. 4 \] characters
Total number of installment payments.
Example: "50" | |
| PmtSeqNb | string \[ 1 .. 2 \] characters
Payment Sequence Number
Example: "20" | | |
| Cntxt | object |
| | | |
| --- | --- |
| PtofSvcCntxt | object |
| | | |
| --- | --- |
| AddtlData | object |
| | | |
| --- | --- |
| Tp | string <= 14 characters
Purchase Restriction Flag. Allows merchants to indicate POS terminal can support card restrictions
Value:"PrchRstrctnInd"
Example: "PrchRstrctnInd" |
| Val | string 1 characters
Contains card restriction value. Valid values: “0” – false, “1” – true
Example: "1" | |
| AttnddInd | boolean
Used to indicate if the card acceptor’s representative is in attendance during the transaction. Semi-attended terminals (e.g., multiple terminals supervised by a single clerk) is considered attended.
Example: true |
| CardDataNtryMd | string <= 4 characters
Contains a card data entry method value which is used to indicate card reading capabilities of the terminal performing the transaction. Valid values: KEEN – Key entered, MGST – Magnetic stripe read and exact content of Track 1 or Track 2 included (CVV check may or may not be possible), OPTC – Optical code (e.g., barcode, QR code), ICCY – Contact integrated circuit card read using VSDC chip data rules; Online CAM authentication method; iCVV checking may or may not be possible, ICPY – Contactless device-read-originated using qVSDC chip data rules; Online CAM authentication method; iCVV checking possible, MSIP - Contactless device-read-originated using magnetic stripe data rules; dCVV checking is possible; Online CAM checking possible for MSD CVN 17 only. CDFL - Credential on file
Enum:"UNSP""KEEN""MGST""OPTC""ICCY""ICPY""MSIP""CDFL"
Example: "KEEN" |
| CardPres | boolean
Card Present
Example: true |
| CrdhldrActvtd | boolean
Contains an unattended cardholder activated environment indicator which indicates whether the automated device was operated solely by the cardholder or not (e.g., vending machine, automated fuel dispenser, ATM, kiosk, etc.)
Example: false |
| CrdhldrPres | boolean
Card Holder Present
Example: true |
| EComrcInd | boolean
Contains a Point-of-Service indicator which is used to indicate whether a transaction originated at the point of service or it’s a E-commerce request.
Example: false | |
| RskCntxt | object |
| | | |
| --- | --- |
| RskAssmnt | Array of objects |
| Array
| | |
| --- | --- |
| AddtlRskData | object |
| | | |
| --- | --- |
| Tp | string <= 11 characters
CC: Condition Code
Example: "CC" |
| Val | string 1 characters
Value for Tp
Example: "10" | |
| RskAssmntTp | string 3 characters
Risk assessment type.
Enum:"MSI""VTA" |
| Rslt | string <= 14 characters
Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring
Example: "UnreliableICVV" | | |
| TxCntxt | object |
| | | |
| --- | --- |
| AntcptdDt | string
Max settlement date for transaction. Date is in Julian date format, yddd
Example: "4077" |
| CaptrDt | string 4 characters
Capture Date in the format MMDD
Example: "0421" |
| CardPrgrmm | object |
| | | |
| --- | --- |
| CardPrgrmmApld | object |
| | | |
| --- | --- |
| Id | string 4 characters
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. All Network ID Codes can be found in 63.1 of the SMS Full Service POS Online Technical Specifications.
Example: "0002" | | |
| MgntcStrpFllbckInd | boolean
Magnetic Strip Fallback Indicator
Example: true |
| MrchntCtgySpcfcData | string 1 characters
Market-Specific Data Identifier
Example: "B" |
| PINPadInprtv | boolean
Contains a PIN Pad indicator which is used to indicate whether or not the PIN pad is operative.
Example: false |
| XchgRateInf | Array of objects |
| Array
| | |
| --- | --- |
| Id | string <= 70 characters
Exchange Rate Identification. Identification of the specific rate, table, or file that contains the rate information.
Example: "A0003" |
| Prvdr | string <= 70 characters
Identifies the source of exchange rate information. Valid value is 'Visa Inc., Exchange Rate'
Example: "Visa Inc., Exchange Rate" |
| RateLck | object |
| | | |
| --- | --- |
| Elgbl | string
Indicates if a transaction is eligible for a rate lock. Possible values Y-true, N-false
Example: "Y" | |
| XchgRateDtl | object |
| | | |
| --- | --- |
| Rate | string <= 8 characters
Contains the exchange rate
Example: "99801539" | | | | |
| Envt | object |
| | | |
| --- | --- |
| Accptr | object |
| | | |
| --- | --- |
| AddtlCtctInf | string \[ 1 .. 255 \] characters
Contains acceptor additional contact information.
Example: "4155551234" |
| Adr | object |
| | | |
| --- | --- |
| AdrLine1 | string \[ 1 .. 99 \] characters
Contains merchant street address. | |
| BizRegnId | string \[ 1 .. 35 \] characters
Contains acceptor business registration ID.
Example: "123456789" |
| BizRegnIdTp | string 2 characters
Contains type of Government Registration Number. 00 (Unspecified), 01 (Tax Registration Identification), 02 (National Identification), 03 (Company Registration Identification), 04 (Passport), 99 (Visa Default Value).
Enum:"00""01""02""03""04""99"
Example: "00" |
| CEDPVrfd | string <= 1 characters
Merchant CEDP Verified Indicator
Example: "Y" |
| CstmrSvc | string \[ 1 .. 13 \] characters
Card-present transactions: contains the location of the merchant outlet where the transaction took place. Card-not-present transactions: contains the merchant’s customer service telephone number, the merchant’s universal resource locator (URL) or internet/e-mail address. NOTE: CstmrSvc will be remapped to Acceptor Customer Service Phone Number in a future release.
Example: "14155552235" |
| Id | string \[ 1 .. 15 \] characters
This field contains an acquirer-assigned code identifying the card acceptor for the transaction. The code can represent a merchant, a merchant location, or a merchant location terminal. If the ID code is less than 15 positions, it must be left-justified and space-filled.
Example: "GCTstore" |
| PhneNb | string <= 16 characters
Contains acceptor phone number.
Example: "4155551234" |
| PrtnrId | string <= 8 characters
Contains acceptor partner ID code. |
| SvcLctn | object |
| | | |
| --- | --- |
| AdrLine1 | string \[ 1 .. 99 \] characters
Contains acceptor service location street address.
Example: "1000 Main Street" |
| Ctry | string 3 characters
Contains acceptor service location country code. |
| CtrySubDvsnMjr | string 3 characters
Contains acceptor service location state/province code. |
| PstlCd | string \[ 4 .. 10 \] characters
Contains acceptor service location postal code.
Example: "94105" |
| TwnNm | string \[ 1 .. 50 \] characters
Contains acceptor service location city name.
Example: "San Francisco" | |
| URL | string \[ 1 .. 255 \] characters
Contains acceptor URL address. | |
| Card | object |
| | | |
| --- | --- |
| AddtlCardData | Array of objects
Example: \[{"Tp":"AcctFndgSrc","Val":"CRDT"}\] |
| Array
| | |
| --- | --- |
| Tp | string <= 11 characters
Type of Additional Card Data. Possible Values - AcctFndgSrc -Account Funding Source.
Example: "AcctFndgSrc" |
| Val | string <= 4 characters
Value associated with type of Account Funding Source. Possible Values - CRDT - Credit, DBIT - Debit, PRPD - Prepaid.
Enum:"CRDT""DBIT""PRPD"
Example: "CRDT" | |
| CardPdctTp | string <= 2 characters
Contains a product ID.
Example: "G1" |
| CardPrtflIdr | string 6 characters
Contains a program identification number used with a product ID attribute
Example: "ABCD12" |
| CardSeqNb | string 4 characters
A number assigned to a card when two or more individual cards are associated with the same primary account number
Example: "0200" |
| PltfrmCd | string 4 characters
Applied Product Platform Code indicates the card product platform. Possible Values - Business - BUSS, Consumer - CSMR, Commercial - COMM, Government - GOVN, Payouts - PYOT.
Enum:"BUSS""CSMR""COMM""GOVN""PYOT"
Example: "BUSS" |
| PmtAccRef | string <= 29 characters
Positions 1 4 contain the BIN controller identifier, a four-character registered value assigned by EMVCo. Positions 5 29 contain a 25-alphanumeric character uppercase unique value linked to a PAN.
Example: "V0010013816097794952255278999" |
| ReplacementPAN | string \[ 13 .. 19 \] characters
Replacement PAN if new PAN requested / Replacement account number provided by Real Time VAU
Example: "4234567890123456" |
| XpryDt | string <= 4 characters
Expiration date of the account number or token in YYMM format.
Example: "2212" | |
| Crdhldr | object |
| | | |
| --- | --- |
| CrdhldrNm | object |
| | | |
| --- | --- |
| GvnNm | string \[ 1 .. 35 \] characters
Contains the first name of account or entity.
Example: "John" |
| LastNm | string \[ 1 .. 35 \] characters
Contains the last name of account or entity.
Example: "Smith" |
| MddlNm | string \[ 1 .. 35 \] characters
Contains the middle name of account or entity.
Example: "Michael" | |
| CstmrDsgnt | string
Account Owner Type. Primary - 01, Secondary - 02
Enum:"Primary""Secondary"
Example: "Primary" |
| Id | object |
| | | |
| --- | --- |
| AssgnrAuthrty | object |
| | | |
| --- | --- |
| Ctry | string 3 characters
Contains the Alpha-3 ISO country code of the issuing country.
Example: "USA" | |
| IdCd | string 4 characters
Contains the Identification Type Code.
Example: "TXIN" |
| IdSubCd | string 2 characters
Contains the Identification Subtype Code. 0B-Business, 0I-Individual
Example: "0B" |
| IdVal | string \[ 1 .. 35 \] characters
Contains the Identification Value.
Example: "12345" | | |
| Termnl | object |
| | | |
| --- | --- |
| Cpblties | object |
| | | |
| --- | --- |
| CrdhldrVrfctnCpblty | object |
| | | |
| --- | --- |
| Cpblty | string 4 characters
Contains a PIN entry capability indicator used to indicate whether or not this terminal can accept online PINs. UNSP – Unknown. NPIN – Indicates terminal can accept and forward online PINs. NOOP – Indicates terminal cannot accept and forward online PINs.
Enum:"UNSP""NPIN""NOOP"
Example: "NOOP" | |
| PINLngthCpblties | string 2 characters
Maximum number of PIN characters that can be accepted by the point-of-service device
Example: "05" | |
| SubTp | string 1 characters
Account Entry Device Type |
| Tp | string <= 4 characters
This field containt code to identifies the basic POS electronic terminal type. MPOS (Use to identify that an mPOS device is used to originate a transaction on an open network)
Example: "MPOS" | | |
| GatewayData | object |
| | | |
| --- | --- |
| AddtnlData | Array of objects |
| Array
| | |
| --- | --- |
| Nm | string <= 35 characters
Contains a special program detail response value. For “ACI”, response values can be found in field 62.1 of the Full Service POS Online Messages Technical Specifications document. For “ValCode”, response values can be found in field 62.3 of the Full Service POS Online Messages Technical Specifications document. For “BusTranTp”, valid value is “1” - Token program. For “USREG”, valid values are “REGU” – regulated account, and “NREG” – nonregulated. For “MVV”, the value sent in the request will be returned in the response. For “SPEND”, the value sent in the request will be returned in the response. For “DwngdRsnCd”, response values can be found in field 62.3 of the Full Service POS Online Messages Technical Specifications document
Enum:"ACI""ValCode""MVV""SPEND""BusTranTp""USREG""DwngdRsnCd""EVV" |
| Val | string \[ 1 .. 10 \] characters
Contains a value “Val” for each “Tp” included in the array. Valid values: REGU – regulated account, NREG – non-regulated account. Valid values for RmbrsmntAttr: 0 - Chip Standard purchase and credit voucher transactions—Canada. Code U also applies to these transactions, 3 - EPS (Australia and New Zealand) and NSR(Canada), 4 - Supermarket Incentive Program (U.S. only), 5 - Electronic Commerce Fee, 7 - Electronic Data Capture(VE only). Not for Asia-Pacific region for original draft transactions.CNP and CVV2 fee programs(VE), 8 - PIN-authenticated Visa Debit, 9 - VPAY Large-Market Petrol (VE Only), B - Applies to:Interregional Electronic, CEMEA Intraregional Electronic, Asia-Pacific Electronic Reimbursement Fee, Canada Chip Fee(only in response), U.K. Card Not Present, U.K. Electronic Hot Card File, International Visa Electron Card, U.K. Airline Interim Interchange Reimbursement Fee VE, Electronic Online Authorized (EOA), Europe EMV Fee, C - Reserved, D - Reserved: Delta-only merchant standard Interchange Reimbursement Fee(U.K. only). CPS/Charity and Religious Organizations and CPS/Retail 2 Fee Programs with MCCs of 8398 (Charitable and Social Service Organizations) and 8661 (Religious Organizations) for specific merchants meeting program requirements(U.S. only), E - Reserved, F - Delta-only merchant Electronic Interchange Reimbursement Fee (U.K. only). Recurring Payment and Emerging Segment Recurring Payment Interchange Reimbursement Fee(Canada only), J - Electronic Interchange Reimbursement Fee (U.S. only). Chip Electronic purchase and credit voucher transactions (Canada only), K - Key-entered Payment Service Reimbursement Fee(U.S. only for select developing markets only), L - Reserved for future use: BASE II Draft data transactions only, M - Card not present Interchange Reimbursement Fee(Canada only), N-S - Reserved for future use: BASE II Draft data transactions only, T - Reserved, U - Emerging Segment Standard(Canada). Chip Standard purchase and credit voucher transactions(Canada). Code 0 also applies to these transactions. In addition, code 0 applies to Chip Standard transactions that request VPP fee programs. Chip Standard transactions that meet Emerging Segment Standard eligibility requirements and fee edit criteria must be submitted with code U., V - Reserved. Valid values for EVV: Any combination of Alphanumeric. No special characters. i.e '00000', '12345', 'ABC12'.
Example: "REGU" | | |
| TxAmts | object |
| | | |
| --- | --- |
| AmtQlfr | string <= 4 characters
Qualifier or type of amount. Possible value is ESTM (Estimated amount) (the final amount could be more or less than the estimated amount
Example: "ESTM" |
| DtldAmt | Array of objects
Example: \[{"Tp":"SRCH","Amt":"100.00"},{"Tp":"CSHB","Amt":"200.00"}\] |
| Array
400
Error
##### Response Schema: application/json
| | |
| --- | --- |
| error | object |
| | | |
| --- | --- |
| code | string <= 5 characters
Code that can be used to contact Visa about a specific error.
Example: "2" |
| msg | string <= 255 characters
Message providing more details about the error
Example: "Invalid Primary Account" | |
| msgIdentfctn | object
Message identification and tracing elements. |
| | | |
| --- | --- |
| correlatnId | string <= 32 characters
correlatnId field must contain the same value as the original transaction being voided.
Example: "12bc567d90f23e56a8f012" |
| reqstId | string <= 32 characters
Unique request ID generated by the server for every reply, even for duplicate transactions. The value can be used to contact Visa about a specific request.
Example: "BC345AF890123456789012" | |
_© Copyright Visa. All Rights Reserved._
_NOTICE: The software and accompanying information and documentation (together, the “Software”) remain the property of and are proprietary to Visa and its suppliers and affiliates. The Software remains protected by intellectual property rights and may be covered by U.S. and foreign patents or patent applications. The Software is licensed and not sold._
_By accessing the Software you are agreeing to Visa's terms of use ( [developer.visa.com/terms](https://developer.visa.com/terms)) and privacy policy ( [usa.visa.com/legal/global-privacy-notice.html](https://usa.visa.com/legal/global-privacy-notice.html)). In addition, all permissible uses of the Software must be in support of Visa products, programs and services provided through the Visa Developer Program (VDP) platform only ( [developer.visa.com](https://developer.visa.com/)). THE SOFTWARE AND ANY ASSOCIATED INFORMATION OR DOCUMENTATION IS PROVIDED ON AN “AS IS,” “AS AVAILABLE,” “WITH ALL FAULTS” BASIS WITHOUT WARRANTY OR CONDITION OF ANY KIND. YOUR USE IS AT YOUR OWN RISK._
post/acs/v3/payments/authorizations/{id}/voids
Sandbox server
https://sandbox.api.visa.com/acs/v3/payments/authorizations/{id}/voids
Copy
Request samples
- Payload
application/json
Copy
Expand allCollapse all
`{"msgIdentfctn": {"clientId": "1VISAGCT000001",
"correlatnId": "Gg6yTAyWkmhyq0jPKHziafG"
},
"Hdr": {"TracData": {"Val": "anyroundtripinfo",
"Tp": "AddtnlTraceData"
}
},
"Body": {"Tx": {"TxAttr": ["INST"\
\
],
"AddtlData": {"Val": "freeformdata",
"Tp": "FreeFormDescData"
},
"AltrnMsgRsn": "2501",
"TxAmts": {"TxAmt": {"Amt": "123.45"
}
}
},
"Envt": {"Accptr": {"PaymentFacltId": "52014057",
"Accptr": "520142254322",
"CstmrSvc": "1 4155552235",
"FrgnRtlrInd": true,
"Adr": {"PstlCd": "78463",
"CtrySubDvsnMjr": "03",
"Ctry": "US",
"CtrySubDvsnMnr": "011"
}
},
"Termnl": {"TermnlId": {"Id": "10012343"
}
}
},
"Cntxt": {"TxCntxt": {"MrchntCtgyCd": "4814"
},
"PtOfSvcCntxt": {"CardDataNtryMd": "CDFL"
}
},
"AdddmData": {"AddtlData": {"Val": "1234567890",
"Tp": "PlanRegSysId"
},
"Instlmt": {"PmtSeqNb": "12",
"Plan": [{"DfrrdInstlmtInd": true,\
\
"PrdUnit": "WEEK",\
\
"SbsqntAmt": "9999.99",\
\
"TtlNbOfPmts": 24,\
\
"InstlmtCcy": 840,\
\
"NbOfPrds": "2",\
\
"PlanOwnr": "ISSR",\
\
"GrdTtlAmt": "234.56"\
\
}\
\
]
}
}
}
}`
Response samples
- 200
- 400
application/json
Copy
Expand allCollapse all
`{"msgIdentfctn": {"reqstId": "14312E380A7211FC72861E215BAB9C99",
"correlatnId": "Gg6yTAyWkmhyq0jPKHziafG",
"id": "382066735140001"
},
"Hdr": {"TracData": {"Val": "anyroundtripinfo",
"Tp": "AddtnlTraceData"
}
},
"Body": {"Tx": {"AddtlData": {"Val": " freeformdata",
"Tp": "FreeFormDescData"
},
"TxAmts": {"TxAmt": {"Ccy": "8",
"Amt": "123.45"
}
}
},
"Envt": {"Card": {"CardPrtflIdr": "292334",
"PmtAccRef": "V0010013822066687991488028016",
"CardPdctTp": "F"
}
},
"Cntxt": {"TxCntxt": {"XchgRateInf": [{"XchgRateDtl": {"Rate": "80933097"\
\
}\
\
}\
\
]
}
},
"PrcgRslt": {"RsltData": {"AddtlRsltInf": [{"Val": "VAU008",\
\
"Tp": "VAURsnCd"\
\
}\
\
],
"RsltDtls": "00",
"Rslt": "Processed"
}
},
"AdddmData": {"AddtlData": {"Val": "1234567890",
"Tp": "PlanRegSysId"
},
"Instlmt": {"PmtSeqNb": "12",
"Plan": [{"DfrrdInstlmtInd": "true",\
\
"PrdUnit": "WEEK",\
\
"SbsqntAmt": "9999.99",\
\
"TtlNbOfPmts": "24",\
\
"InstlmtCcy": "840",\
\
"NbOfPrds": "2",\
\
"PlanOwnr": "ISSR",\
\
"GrdTtlAmt": "234.56"\
\
}\
\
]
}
}
}
}`