# VisaNet Connect - Acceptance
Process in-store, in-app, and online payments through a direct interface to Visa’s global payments system.
## Version: 1
### Servers
| URL | Description |
| --- | ----------- |
| https://sandbox.api.visa.com | Sandbox server |
---
## Authorization API
Visa Payments Processing API
### [POST] /acs/v3/payments/authorizations/{id}/voids
**Void Authorizations with id v3**
Used to void an "Authorizations" resource.
#### Parameters
| Name | Located in | Description | Required | Schema | Style | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ----- | ------- |
| id | path | Id used in path | Yes | string | simple | No |
#### Request Body
Request data
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: { **"Hdr"**: { **"NttyId"**: string, **"TracData"**: { **"Tp"**: string, **"Val"**: string } }, **"Body"**: { **"Tx"**: { **"TxId"**: { **"LclDtTm"**: string, **"AssctdTxLifeCyclId"**: string }, **"AcctFr"**: { **"AcctId"**: string }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxAttr"**: [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ], **"TxSubTp"**: string, **"AddtlSvc"**: { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AltrnMsgRsn"**: string, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } }, **"Envt"**: { **"Card"**: { **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"SchmeId"**: string, **"CardSeqNb"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"SaleCntxt"**: { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" }, **"PtOfSvcCntxt"**: { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: [ { **"Id"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"NtlData"**: { **"Ctry"**: string, **"VATRate"**: string, **"IRFIndicator"**: string,
**Available values:** "D", "S", **"InstlmtPmtNb"**: string, **"InstlmtPmtInd"**: string, **"NbOfInstlmtPmts"**: string, **"InstlmtPmtIntrstSttlmInd"**: string,
**Available values:** "A", "D" }, **"NtnlData"**: { **"CountryCd"**: string, **"SpainData"**: [ { **"LclAccptrId"**: string, **"LclMrchntCtgyCd"**: string } ], **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC", **"Val"**: string } ] }, **"AdddmData"**: { **"Ldgg"**: { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] }, **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"TrvlAgcy"**: { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } }, **"VhclRntl"**: { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"PurchsIdr"**: string, **"PurchsIdrTp"**: string,
**Available values:** "ORNU", "REAG", "FONU", **"PssngrTrnsprt"**: { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC" }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } } ] }, **"msgIdentfctn"**: { **"clientId"**: string, **"correlatnId"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: { **"Hdr"**: { **"TracData"**: { **"Tp"**: string, **"Val"**: string } }, **"Body"**: { **"Tx"**: { **"TxId"**: { **"CardIssrRefData"**: string }, **"AcctFr"**: { **"AcctId"**: string, **"AcctTp"**: string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxSubTp"**: string, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ], **"ApldSvc"**: string } }, **"Envt"**: { **"Card"**: { **"XpryDt"**: string, **"PltfrmCd"**: string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT", **"CardSeqNb"**: string, **"PmtAccRef"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string, **"AddtlCardData"**: [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ], **"ReplacementPAN"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"AdrLine1"**: string }, **"URL"**: string, **"PhneNb"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"CEDPVrfd"**: string, **"CstmrSvc"**: string, **"BizRegnId"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"AddtlCtctInf"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"TxCntxt"**: { **"CaptrDt"**: string, **"AntcptdDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"XchgRateInf"**: [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ], **"PINPadInprtv"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"RskCntxt"**: { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", **"AddtlRskData"**: { **"Tp"**: string, **"Val"**: string } } ] }, **"PtofSvcCntxt"**: { **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"PrcgRslt"**: { **"RsltData"**: { **"Rslt"**: string,
**Available values:** "Processed", "NotProcessed", "Error", **"RsltDtls"**: string, **"AddtlRsltInf"**: [ { **"Tp"**: string, **"Val"**: string } ] }, **"ApprvlData"**: { **"ApprvlCd"**: string } }, **"AdddmData"**: { **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ], **"PmtSeqNb"**: string }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC", **"SplmntryData"**: { **"TSPId"**: string, **"MsgClss"**: string, **"Termnltp"**: string, **"POSCondCd"**: string, **"ChipCondCd"**: string, **"RtrvlRefNb"**: string, **"TknRqstrId"**: string, **"SysTracAudtNb"**: string, **"TrnsmssnDtTm "**: string, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" } }, **"ICCRltdData"**: string }, **"msgIdentfctn"**: { **"id"**: string, **"reqstId"**: string, **"correlatnId"**: string } }
|
| 400 | Error | **application/json**: { **"error"**: { **"msg"**: string, **"code"**: string }, **"msgIdentfctn"**: { **"reqstId"**: string, **"correlatnId"**: string } }
|
### [POST] /acs/v3/payments/authorizations
**Authorizations v3**
Used for new "Authorizations" resource requests.
#### Request Body
Request data
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: { **"Hdr"**: { **"NttyId"**: string, **"TracData"**: { **"Tp"**: string, **"Val"**: string } }, **"Body"**: { **"Tx"**: { **"Tax"**: { **"Tp"**: string,
**Available values:** "LOCL", "VATA", **"Amt"**: string, **"Dcmnttn"**: string }, **"TxId"**: { **"LclDtTm"**: string }, **"AcctFr"**: { **"AcctId"**: string }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxAttr"**: [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ], **"TxDesc"**: string, **"TxSubTp"**: string, **"AddtlSvc"**: [ { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" } ], **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AltrnMsgRsn"**: string, **"PreAuthstnTmLmt"**: string, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } }, **"Envt"**: { **"Card"**: { **"PAN"**: string, **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"XpryDt"**: string, **"SchmeId"**: string, **"CardSeqNb"**: string }, **"Wllt"**: { **"Prvdr"**: { **"Id"**: string,
**Available values:** "VCIND" } }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"PrvtData"**: { **"GtwyMrchntData"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"RskCntxt"**: { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA" } ] }, **"SaleCntxt"**: { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" }, **"PtOfSvcCntxt"**: { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: { **"Id"**: string }, **"EComrcData"**: [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"PrtlApprvlSpprtd"**: boolean } }, **"NtlData"**: { **"Ctry"**: string, **"VATRate"**: string, **"IRFIndicator"**: string,
**Available values:** "D", "S", **"InstlmtPmtNb"**: string, **"InstlmtPmtInd"**: string, **"NbOfInstlmtPmts"**: string, **"InstlmtPmtIntrstSttlmInd"**: string,
**Available values:** "A", "D" }, **"NtnlData"**: { **"CountryCd"**: string, **"SpainData"**: [ { **"LclAccptrId"**: string, **"LclMrchntCtgyCd"**: string } ], **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC", **"Val"**: string } ] }, **"AdddmData"**: { **"Ldgg"**: { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] }, **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"TrvlAgcy"**: { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } }, **"VhclRntl"**: { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"Drtn"**: string, **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"PurchsIdr"**: string, **"PurchsIdrTp"**: string,
**Available values:** "ORNU", "REAG", "FONU", **"PssngrTrnsprt"**: { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"PrtctdData"**: { **"NcrptdData"**: { **"Algo"**: string,
**Available values:** "TDEA", "AES", **"Ctrl"**: string,
**Available values:** "DUKPT", "ZCK", **"DrvdInf"**: string, **"KeyIndx"**: string, **"KeySetIdr"**: string, **"PINBlckFrmt"**: string, **"NcrptdPINBlck"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC" }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } } ] }, **"msgIdentfctn"**: { **"origId"**: string, **"clientId"**: string, **"correlatnId"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: { **"Hdr"**: { **"TracData"**: { **"Tp"**: string, **"Val"**: string } }, **"Body"**: { **"Tx"**: { **"Tax"**: { **"Tp"**: string,
**Available values:** "VATA", **"Dcmnttn"**: string }, **"TxId"**: { **"CardIssrRefData"**: string, **"LifeCyclIdVldtn"**: string }, **"AcctFr"**: { **"AcctId"**: string, **"AcctTp"**: string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxSubTp"**: string, **"AddtlSvc"**: [ { **"Tp"**: string,
**Available values:** "OTHP", "P001", **"Dtl"**: { **"AgeRslt"**: string, **"DOBRslt"**: string }, **"Rslt"**: string,
**Available values:** "PERF", "NOPF", "NOSP", "OTHP", **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId", **"OthrRslt"**: string } ], **"AddtlAmts"**: { **"Tp"**: string,
**Available values:** "AMTQ", **"Amt"**: { **"Amt"**: string, **"Ccy"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AssoctdDataDstn"**: string, **"SpclPrgrmmQlfctn"**: { **"IMP"**: string, **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ], **"Prgrmm"**: string, **"ApldSvc"**: string } }, **"Envt"**: { **"Card"**: { **"PltfrmCd"**: string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT", **"CardSeqNb"**: string, **"PmtAccRef"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string, **"AddtlCardData"**: [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ], **"ReplacementPAN"**: string, **"PANFourLastDgts"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"AdrLine1"**: string }, **"URL"**: string, **"PhneNb"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"CEDPVrfd"**: string, **"CstmrSvc"**: string, **"BizRegnId"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"AddtlCtctInf"**: string }, **"Termnl"**: { **"Tp"**: string, **"Cpblties"**: { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", "CRYP", "NVSC", "OTHP", **"VrfctnRslt"**: { **"Tp"**: string, **"Rslt"**: string,
**Available values:** "SUCC", "NOVF", "FAIL", "ERRR", "MISS", **"RsltDtls"**: string } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"AntcptdDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"XchgRateInf"**: [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ], **"PINPadInprtv"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"RskCntxt"**: { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", "VAI" } ] }, **"PtOfSvcCntxt"**: { **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"EComrcData"**: [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"PrcgRslt"**: { **"RsltData"**: { **"Rslt"**: string,
**Available values:** "Approved", "PartiallyApproved", "NoReasonToDecline", "Declined", "Error", **"RsltDtls"**: string, **"AddtlRsltInf"**: [ { **"Tp"**: string, **"Val"**: string } ] }, **"ApprvlData"**: { **"ApprvlCd"**: string } }, **"AdddmData"**: { **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC", **"SplmntryData"**: { **"TSPId"**: string, **"MsgClss"**: string, **"Termnltp"**: string, **"POSCondCd"**: string, **"ChipCondCd"**: string, **"RtrvlRefNb"**: string, **"TknRqstrId"**: string, **"SysTracAudtNb"**: string, **"TrnsmssnDtTm "**: string, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" } }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string, **"RsnNotHnrd"**: string } ], **"DlgtdAuthrty"**: string } } ] }, **"_links"**: { **"authVoid"**: { **"href"**: object }, **"authCapture"**: { **"href"**: object } }, **"msgIdentfctn"**: { **"id"**: string, **"reqstId"**: string, **"correlatnId"**: string } }
|
| 400 | Error | **application/json**: { **"error"**: { **"msg"**: string, **"code"**: string }, **"msgIdentfctn"**: { **"reqstId"**: string, **"correlatnId"**: string } }
|
### [POST] /acs/v3/payments/authorizations/voids
**Void Authorizations without id v3**
Used to void an "Authorizations" resource without a resource id.
#### Request Body
Request data
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: { **"Hdr"**: { **"NttyId"**: string, **"TracData"**: { **"Tp"**: string, **"Val"**: string } }, **"Body"**: { **"Tx"**: { **"TxId"**: { **"LclDtTm"**: string, **"AssctdTxLifeCyclId"**: string }, **"AcctFr"**: { **"AcctId"**: string }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxAttr"**: [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ], **"TxSubTp"**: string, **"AddtlSvc"**: { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AltrnMsgRsn"**: string, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } }, **"Envt"**: { **"Card"**: { **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"SchmeId"**: string, **"CardSeqNb"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"SaleCntxt"**: { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" }, **"PtOfSvcCntxt"**: { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: [ { **"Id"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"NtlData"**: { **"Ctry"**: string, **"VATRate"**: string, **"IRFIndicator"**: string,
**Available values:** "D", "S", **"InstlmtPmtNb"**: string, **"InstlmtPmtInd"**: string, **"NbOfInstlmtPmts"**: string, **"InstlmtPmtIntrstSttlmInd"**: string,
**Available values:** "A", "D" }, **"NtnlData"**: { **"CountryCd"**: string, **"SpainData"**: [ { **"LclAccptrId"**: string, **"LclMrchntCtgyCd"**: string } ], **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC", **"Val"**: string } ] }, **"AdddmData"**: { **"Ldgg"**: { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] }, **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"TrvlAgcy"**: { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } }, **"VhclRntl"**: { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"PurchsIdr"**: string, **"PurchsIdrTp"**: string,
**Available values:** "ORNU", "REAG", "FONU", **"PssngrTrnsprt"**: { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } } ] }, **"msgIdentfctn"**: { **"clientId"**: string, **"correlatnId"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Success | **application/json**: { **"Hdr"**: { **"TracData"**: { **"Tp"**: string, **"Val"**: string } }, **"Body"**: { **"Tx"**: { **"TxId"**: { **"CardIssrRefData"**: string }, **"AcctFr"**: { **"AcctId"**: string, **"AcctTp"**: string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxSubTp"**: string, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ], **"ApldSvc"**: string } }, **"Envt"**: { **"Card"**: { **"XpryDt"**: string, **"PltfrmCd"**: string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT", **"CardSeqNb"**: string, **"PmtAccRef"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string, **"AddtlCardData"**: [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ], **"ReplacementPAN"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"AdrLine1"**: string }, **"URL"**: string, **"PhneNb"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"CEDPVrfd"**: string, **"CstmrSvc"**: string, **"BizRegnId"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"AddtlCtctInf"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"TxCntxt"**: { **"CaptrDt"**: string, **"AntcptdDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"XchgRateInf"**: [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ], **"PINPadInprtv"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"RskCntxt"**: { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", **"AddtlRskData"**: { **"Tp"**: string, **"Val"**: string } } ] }, **"PtofSvcCntxt"**: { **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"PrcgRslt"**: { **"RsltData"**: { **"Rslt"**: string,
**Available values:** "Processed", "NotProcessed", "Error", **"RsltDtls"**: string, **"AddtlRsltInf"**: [ { **"Tp"**: string, **"Val"**: string } ] }, **"ApprvlData"**: { **"ApprvlCd"**: string } }, **"AdddmData"**: { **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ], **"PmtSeqNb"**: string }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC", **"SplmntryData"**: { **"TSPId"**: string, **"MsgClss"**: string, **"Termnltp"**: string, **"POSCondCd"**: string, **"ChipCondCd"**: string, **"RtrvlRefNb"**: string, **"TknRqstrId"**: string, **"SysTracAudtNb"**: string, **"TrnsmssnDtTm "**: string, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" } }, **"ICCRltdData"**: string }, **"msgIdentfctn"**: { **"id"**: string, **"reqstId"**: string, **"correlatnId"**: string } }
|
| 400 | Error | **application/json**: { **"error"**: { **"msg"**: string, **"code"**: string }, **"msgIdentfctn"**: { **"reqstId"**: string, **"correlatnId"**: string } }
|
---
## Settlement Position Inquiry API
Settlement Position Inquiry API
### [GET] /settlement/v1/positions
**Get Settlement**
Get Settlement Windows
#### Parameters
| Name | Located in | Description | Required | Schema | Style | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ----- | ------- |
| clientId | query | Client Profile ID to query on | Yes | string | form | Yes |
| offset | query | This is the offset into the results to begin returning from | No | integer | form | Yes |
| limit | query | This is the maximum number of reults to return in a single response message. | No | integer | form | Yes |
| asofdttm | query | Query for results as of a particular time stamp. | No | string | form | Yes |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | ok | **application/json**: { **"GetSettlementResponse"**: { **"pagingInfo"**: { **"offset"**: string, **"asofdttm"**: string }, **"setlposcount"**: string, **"settlementRecords"**: [ { **"ssid"**: string, **"sreid"**: string, **"setldate"**: string, **"cutofftime"**: string, **"setlposamt"**: { **"setlcurrcd"**: string, **"amountValue"**: string, **"amountMinorUnits"**: string }, **"setlposind"**: string, **"setlpossign"**: string } ] } }
|
| 400 | error response | **application/json**: { **"error"**: { **"code"**: integer, **"message"**: string } }
|
---
### Schemas
#### 400 Schema
Used when validation fails or transaction is rejected.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| error | { **"msg"**: string, **"code"**: string } | | No |
| msgIdentfctn | { **"reqstId"**: string, **"correlatnId"**: string } | Message identification and tracing elements. | No |
#### tCode Schema
Code that can be used to contact Visa about a specific error.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tCode | string | Code that can be used to contact Visa about a specific error. | |
**Example**
2
#### authVoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| href | object | Hypermedia link.
*Example:* `"https://sandbox.api.visa.com/acs/v3/payments/authorizations/123456789012345/voids"` | No |
#### CardIssrRefData Schema
Gateway Transaction ID
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardIssrRefData | string | Gateway Transaction ID | |
**Example**
1234567
#### ShrtNm Schema
Contains the name of the card acceptor (merchant)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ShrtNm | string | Contains the name of the card acceptor (merchant) | |
**Example**
ABC Supplies
#### PmtAccRef Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PmtAccRef | string | 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
#### TtlFees Schema
Total Fees
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlFees | string | Total Fees | |
**Example**
20.00
#### 200_authorizations_void Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Hdr | { **"TracData"**: { **"Tp"**: string, **"Val"**: string } } | | No |
| Body | { **"Tx"**: { **"TxId"**: { **"CardIssrRefData"**: string }, **"AcctFr"**: { **"AcctId"**: string, **"AcctTp"**: string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxSubTp"**: string, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ], **"ApldSvc"**: string } }, **"Envt"**: { **"Card"**: { **"XpryDt"**: string, **"PltfrmCd"**: string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT", **"CardSeqNb"**: string, **"PmtAccRef"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string, **"AddtlCardData"**: [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ], **"ReplacementPAN"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"AdrLine1"**: string }, **"URL"**: string, **"PhneNb"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"CEDPVrfd"**: string, **"CstmrSvc"**: string, **"BizRegnId"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"AddtlCtctInf"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"TxCntxt"**: { **"CaptrDt"**: string, **"AntcptdDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"XchgRateInf"**: [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ], **"PINPadInprtv"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"RskCntxt"**: { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", **"AddtlRskData"**: { **"Tp"**: string, **"Val"**: string } } ] }, **"PtofSvcCntxt"**: { **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"PrcgRslt"**: { **"RsltData"**: { **"Rslt"**: string,
**Available values:** "Processed", "NotProcessed", "Error", **"RsltDtls"**: string, **"AddtlRsltInf"**: [ { **"Tp"**: string, **"Val"**: string } ] }, **"ApprvlData"**: { **"ApprvlCd"**: string } }, **"AdddmData"**: { **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ], **"PmtSeqNb"**: string }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC", **"SplmntryData"**: { **"TSPId"**: string, **"MsgClss"**: string, **"Termnltp"**: string, **"POSCondCd"**: string, **"ChipCondCd"**: string, **"RtrvlRefNb"**: string, **"TknRqstrId"**: string, **"SysTracAudtNb"**: string, **"TrnsmssnDtTm "**: string, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" } }, **"ICCRltdData"**: string } | | No |
| msgIdentfctn | { **"id"**: string, **"reqstId"**: string, **"correlatnId"**: string } | Message identification and tracing elements. | No |
#### PrtlApprvlSpprtd Schema
Indicates whether the terminal can support partially approved amounts. Set to true if partial authorization is supported and false if partial authorization is not supported
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PrtlApprvlSpprtd | boolean | Indicates whether the terminal can support partially approved amounts. Set to true if partial authorization is supported and false if partial authorization is not supported | |
**Example**
true
#### RcrngPmt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "1", "2", "3", "4" | Recurring Payment Type. 1(Registration/first transaction), 2(Subsequent transaction), 3(Modification), 4(Cancellation)
*Enum:* `"1"`, `"2"`, `"3"`, `"4"`
*Example:* `"1"` | No |
| Frqcy | string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO" | 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"` | No |
| MaxAmt | string | Maximum amount agreed to by the cardholder. Amount will be specified in F49 currency(Currency Code, Transaction)
*Example:* `"100.00"` | No |
| ValInd | string,
**Available values:** "true", "false" | Validation Indictor. Offline validation between Acquirer and Issuer during registration: false(not validated), true(validated)
*Enum:* `"true"`, `"false"`
*Example:* `"true"` | No |
| NbOfPmt | string | 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"` | No |
| RegnRefNb | string | 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"` | No |
| PerTxAmtTp | string,
**Available values:** "1", "2" | Payment Amount Indicator Per Transaction. 1(Fixed amount Recurring Payment), 2(Recurring Payment with maximum amount)
*Enum:* `"1"`, `"2"`
*Example:* `"1"` | No |
#### SvcTp Schema
Service Type. FLSV(Full service), SLSV(Self service)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SvcTp | string,
**Available values:** "FLSV", "SLSV" | Service Type. FLSV(Full service), SLSV(Self service) | |
**Example**
FLSV
#### correlatnId Schema
correlatnId field must contain the same value as the original transaction being voided.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| correlatnId | string | correlatnId field must contain the same value as the original transaction being voided. | |
**Example**
12bc567d90f23e56a8f012
#### BizRegnIdTp Schema
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).
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BizRegnIdTp | string,
**Available values:** "00", "01", "02", "03", "04", "99" | 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). | |
**Example**
00
#### tTx Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tax | { **"Tp"**: string,
**Available values:** "LOCL", "VATA", **"Amt"**: string, **"Dcmnttn"**: string } | | No |
| TxId | { **"LclDtTm"**: string } | | No |
| AcctFr | { **"AcctId"**: string } | | No |
| TxAmts | { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] } | | No |
| TxAttr | [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ] | *Example:* `["MOTO","INST"]` | No |
| TxDesc | string | Information about the merchandise in the transaction.
*Example:* `"transactiondescription"` | No |
| TxSubTp | string | Business Application Identifier - CB Consumer Bill Payment
*Example:* `"CB"` | No |
| AddtlSvc | [ { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" } ] | | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string } | | No |
| AltrnMsgRsn | string | 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"` | No |
| PreAuthstnTmLmt | string | Preauth Time Limit in minutes.This field contains the time an issuer agrees to hold funds for an acquirer requesting an 0100 preauthorization. This field applies to preauthorizations and completions only.
*Example:* `"12"` | No |
| SpclPrgrmmQlfctn | { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } | | No |
#### PtOfSvcCntxtvoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardPres | boolean | Card Present
*Example:* `true` | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string } | | No |
| 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` | No |
| 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` | No |
| CrdhldrPres | boolean | Card Holder Present
*Example:* `true` | No |
| 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` | No |
| CardDataNtryMd | string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" | 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"` | No |
#### GtwyMrchntData Schema
Gateway Merchant Data Bank ABA number.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GtwyMrchntData | string | Gateway Merchant Data Bank ABA number. | |
**Example**
V070990024552
#### GoodsAndSvcsTp Schema
Specifies the type of goods and/or services sold. Possible values are: ELEC (Electronic goods and services), PHYS (Physical goods or services)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GoodsAndSvcsTp | string,
**Available values:** "ELEC", "PHYS" | Specifies the type of goods and/or services sold. Possible values are: ELEC (Electronic goods and services), PHYS (Physical goods or services) | |
**Example**
ELEC
#### Tckt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ChngInd | string | Contains a code that indicates why a ticket was changed.
*Example:* `"N"` | No |
| RstrctdTcktInd | string | This subfield is used to indicate the purchase of a nonrefundable ticket. It is a conditional subfield for passenger transport transactions.
*Example:* `"1"` | No |
#### AnnlTtlCostFin Schema
Annual Total Cost of Financing
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AnnlTtlCostFin | string | Annual Total Cost of Financing | |
**Example**
4
#### tEnvt2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Card | { **"XpryDt"**: string, **"PltfrmCd"**: string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT", **"CardSeqNb"**: string, **"PmtAccRef"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string, **"AddtlCardData"**: [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ], **"ReplacementPAN"**: string } | | No |
| Accptr | { **"Id"**: string, **"Adr"**: { **"AdrLine1"**: string }, **"URL"**: string, **"PhneNb"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"CEDPVrfd"**: string, **"CstmrSvc"**: string, **"BizRegnId"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"AddtlCtctInf"**: string } | | No |
| Termnl | { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } } } | | No |
| Crdhldr | { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } | | No |
#### Pssngr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Nm | string | This 20-character subfield contains the passenger's name and is left-justified. Right space-fill is required.
*Example:* `"John Smith"` | No |
#### VhclRntlvoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RntlInvc | { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer } | | No |
| RntlAgrmt | { **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } | | No |
#### Rsn Schema
Value for CSCV Value not entered
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Rsn | string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard" | Value for CSCV Value not entered | |
#### NbOfPrds Schema
Number of Periods
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NbOfPrds | string,
**Available values:** "1", "2", "4", ".5" | Number of Periods | |
**Example**
1
#### LineItm Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LineItm | [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] | 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. | |
#### arrayPlan Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlTax | string | Total Taxes
*Example:* `"10.00"` | No |
| PrdUnit | string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN" | Period unit between consecutive payments
*Enum:* `"YEAR"`, `"MNTH"`, `"QURT"`, `"WEEK"`, `"MIAN"`
*Example:* `"WEEK"` | No |
| TtlFees | string | Total Fees
*Example:* `"20.00"` | No |
| GracePrd | string | Grace Period. Contains number of months from 00-99 that the payment is not required.
*Example:* `"02"` | No |
| NbOfPrds | string,
**Available values:** "1", "2", "4", ".5" | Number of Periods
*Enum:* `"1"`, `"2"`, `"4"`, `".5"`
*Example:* `"1"` | No |
| PlanOwnr | string,
**Available values:** "ISSR", "ACCP" | Installment plan owner. ISSR = 01, ACCP = 03
*Enum:* `"ISSR"`, `"ACCP"`
*Example:* `"ISSR"` | No |
| FrstPmtDt | string | Date of First Installment YYMMDD
*Example:* `"230421"` | No |
| GrdTtlAmt | string | 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"` | No |
| PctAmtReq | string | Percent of Amount Requested.
*Example:* `"13"` | No |
| PctTtlTax | string | Percent of Total taxes
*Example:* `"4"` | No |
| SbsqntAmt | string | Approximate Amount of each Installment
*Example:* `"6500.00"` | No |
| TtlExpnss | string | Total Expenses
*Example:* `"23.00"` | No |
| TtlInsrnc | string | Total Insurance
*Example:* `"10.00"` | No |
| InstlmtCcy | string | Currency code associated with the instalment amount. ISO 4217 "Codes for the representation of currencies and funds".
*Example:* `"840"` | No |
| PctTtlFees | string | Percent of Total Fees
*Example:* `"4"` | No |
| TtlAmtFund | string | Total Amount Funded
*Example:* `"23.00"` | No |
| TtlNbOfPmts | string | Total number of installment payments.
*Example:* `"50"` | No |
| TtlOthrCost | string | Total Other Costs
*Example:* `"8.00"` | No |
| InstlmtPmtTp | string,
**Available values:** "0", "1", "2", "3" | Installment Payment Type
*Enum:* `"0"`, `"1"`, `"2"`, `"3"`
*Example:* `"1"` | No |
| PctTtlExpnss | string | Percent of Total Expenses
*Example:* `"3"` | No |
| PctTtlInsrnc | string | Percent of Total Insurance
*Example:* `"4"` | No |
| InstlmtIntrst | string | Installment Payment Interest
*Example:* `"0.13"` | No |
| AnnlIntrstRate | string | Annual Interest Rate
*Example:* `"4"` | No |
| AnnlTtlCostFin | string | Annual Total Cost of Financing
*Example:* `"4"` | No |
| MnthIntrstRate | string | Monthly Interest Rates
*Example:* `"6"` | No |
| PctTtlOtherCost | string | Percent of Total Other Costs
*Example:* `"3"` | No |
| VATInstlmtIntrst | string | VAT for Installment Payment Interest. Vat calculated by acquirer for interest applicable to the transaction.
*Example:* `"5.13"` | No |
#### LclAccptrId Schema
Contains Spanish merchant ID when it differs from the international merchant ID.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LclAccptrId | string | Contains Spanish merchant ID when it differs from the international merchant ID. | |
#### GatewayAddtnlDataResp Schema
Addtnldata for GatewayData. Contains Tp, Val pairs of data for non-Visa branded cards. Please reference the VPP release notes for a list of all Tp and Val pairs
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "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" | 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"`
*Example:* `"MAICA"` | No |
| 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"` | No |
#### PANFourLastDgts Schema
Last 4 digits of the account number.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PANFourLastDgts | string | Last 4 digits of the account number. | |
**Example**
3456
#### tVoidRslt1 Schema
Transaction result.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tVoidRslt1 | string,
**Available values:** "Processed", "NotProcessed", "Error" | Transaction result. | |
#### Frqcy Schema
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)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Frqcy | string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO" | 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) | |
**Example**
DAIL
#### AnnlIntrstRate Schema
Annual Interest Rate
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AnnlIntrstRate | string | Annual Interest Rate | |
**Example**
4
#### Summryres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Drvr | { **"Id"**: string, **"MplyeeId"**: string } | | No |
| Vhcl | { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string } | | No |
| TripInf | { **"JobNb"**: string } | | No |
| AddtlData | { **"Tp"**: string, **"Val"**: string } | | No |
| TxRltdData | { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string } | | No |
| AgtFuelPrmptCd1 | string | Fleet Additional Prompted Data 1. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
*Example:* `"123456789kiikjhasjk1"` | No |
| AgtFuelPrmptCd2 | string | Fleet Additional Prompted Data 2. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
*Example:* `"123456789kiikjhasjk1"` | No |
#### tSpnsrdMrchnt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | { **"Id"**: string } | | No |
#### tRskAssmntArrayReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tRskAssmntArrayReq | [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA" } ] | | |
#### NtlData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Ctry | string | Contains a country code for jurisdictions participating in domestic processing.
*Example:* `"032"` | No |
| VATRate | string | 4-byte subfield must contain a 4-digit VAT rate with two decimal places.
*Example:* `"1.00"` | No |
| IRFIndicator | string,
**Available values:** "D", "S" | 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"` | No |
| InstlmtPmtNb | string | 2-byte numeric subfield can contain installment payment number from 01-99.
*Example:* `"11"` | No |
| InstlmtPmtInd | string | 2-byte alphanumeric subfield contains installment payment indicator. Valid values: CO (Sale/Cash Disbursement).
*Example:* `"CO"` | No |
| NbOfInstlmtPmts | string | 2-byte numeric subfield can contain number of installment payments from 01-99.
*Example:* `"12"` | No |
| InstlmtPmtIntrstSttlmInd | string,
**Available values:** "A", "D" | 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"` | No |
#### tRsltData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Rslt | string,
**Available values:** "Approved", "PartiallyApproved", "NoReasonToDecline", "Declined", "Error" | Transaction result.
*Enum:* `"Approved"`, `"PartiallyApproved"`, `"NoReasonToDecline"`, `"Declined"`, `"Error"` | No |
| RsltDtls | string | Results of transaction request.
*Example:* `"00"` | No |
| AddtlRsltInf | [ { **"Tp"**: string, **"Val"**: string } ] | | No |
#### tempdef15 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | Request from Merchant for Updated Account
*Example:* `"NewPANRequested"` | No |
#### tempdef14 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string,
**Available values:** "VCIND" | Location where the credentials are stored on file. Possible values include: VCIND - Indicates that the transaction was processed through Visa Checkout.
*Enum:* `"VCIND"`
*Example:* `"VCIND"` | No |
#### PctTtlExpnss Schema
Percent of Total Expenses
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PctTtlExpnss | string | Percent of Total Expenses | |
**Example**
3
#### tRskAssmntArrayRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tRskAssmntArrayRes | [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", "VAI" } ] | | |
#### tempdef12 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | Sub-merchant Identifier
*Example:* `"520140578465770"` | No |
#### arrayPlanres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PrdUnit | string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN" | Period unit between consecutive payments
*Enum:* `"YEAR"`, `"MNTH"`, `"QURT"`, `"WEEK"`, `"MIAN"`
*Example:* `"WEEK"` | No |
| NbOfPrds | string,
**Available values:** "1", "2", "4", ".5" | Number of Periods
*Enum:* `"1"`, `"2"`, `"4"`, `".5"`
*Example:* `"1"` | No |
| PlanOwnr | string,
**Available values:** "ISSR", "ACCP" | Installment plan owner. ISSR = 01, ACCP = 03
*Enum:* `"ISSR"`, `"ACCP"`
*Example:* `"ISSR"` | No |
| GrdTtlAmt | string | 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"` | No |
| SbsqntAmt | string | Approximate Amount of each Installment
*Example:* `"6500.00"` | No |
| InstlmtCcy | string | Currency code associated with the instalment amount. ISO 4217 "Codes for the representation of currencies and funds".
*Example:* `"840"` | No |
| TtlNbOfPmts | string | Total number of installment payments.
*Example:* `"50"` | No |
#### tempdef42 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Vrfctn | [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ] | *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"}}}]` | No |
| TxCntxt | { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string } | | No |
| SaleCntxt | { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" } | | No |
| PtOfSvcCntxt | { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: [ { **"Id"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } | | No |
#### tSpclConds1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tSpclConds1 | [ { **"Id"**: string } ] | | |
#### tempdef41 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Card | { **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"SchmeId"**: string, **"CardSeqNb"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string } | | No |
| Accptr | { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string } | | No |
| Termnl | { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } } | | No |
| Crdhldr | { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } | | No |
#### tempdef27DtlsNmValres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Nm | string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV" | 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"` | No |
| Val | string | 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"` | No |
**Example**
[
{
"Nm": "ACI",
"Val": "Y"
},
{
"Nm": "MVV",
"Val": "7000028765"
},
{
"Nm": "BusTranTp",
"Val": "1"
}
]
#### tempdef27DtlsNmValreq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Nm | string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV" | 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"` | No |
| Val | string | 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"` | No |
**Example**
[
{
"Nm": "ACI",
"Val": "Y"
}
]
#### CardPrgrmm Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardPrgrmmApld | { **"Id"**: string } | | No |
#### FrstPmtDt Schema
Date of First Installment YYMMDD
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FrstPmtDt | string | Date of First Installment YYMMDD | |
**Example**
230421
#### PINData Schema
Security Related Control Information
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Algo | string | Algorithm ID
*Example:* `"01"` | No |
| KeyIndx | string | Zone Key Index
*Example:* `"01"` | No |
| PINBlckFrmt | string | PIN Block Format
*Example:* `"01"` | No |
#### AntcptdDt Schema
Max settlement date for transaction. Date is in Julian date format, yddd
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AntcptdDt | string | Max settlement date for transaction. Date is in Julian date format, yddd | |
**Example**
4077
#### CrdhldrNm Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GvnNm | string | Contains the first name of account or entity.
*Example:* `"John"` | No |
| LastNm | string | Contains the last name of account or entity.
*Example:* `"Smith"` | No |
| MddlNm | string | Contains the middle name of account or entity.
*Example:* `"Michael"` | No |
#### TtlAmtFund Schema
Total Amount Funded
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlAmtFund | string | Total Amount Funded | |
**Example**
23.00
#### AddtlDataPrchRstrctnInd Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "PrchRstrctnInd" | Purchase Restriction Flag. Allows merchants to indicate POS terminal can support card restrictions
*Enum:* `"PrchRstrctnInd"`
*Example:* `"PrchRstrctnInd"` | No |
| Val | string | Contains card restriction value. Valid values: “0” – false, “1” – true
*Example:* `"1"` | No |
#### Id1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | Request from Merchant for Updated Account.
*Example:* `"NewPANRequested"` | No |
#### tTxAmt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Amt | string | Transaction amount with explicit decimal point to represent minor unit.
*Example:* `"123.45"` | No |
| Ccy | string | Numeric currency code conforming to ISO 4217.
*Example:* `"840"` | No |
#### tempdef49 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Rslt | string,
**Available values:** "Processed", "NotProcessed", "Error" | Transaction result.
*Enum:* `"Processed"`, `"NotProcessed"`, `"Error"` | No |
| RsltDtls | string | Results of transaction request.
*Example:* `"00"` | No |
| AddtlRsltInf | [ { **"Tp"**: string, **"Val"**: string } ] | | No |
#### tempdef47 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RsltData | { **"Rslt"**: string,
**Available values:** "Processed", "NotProcessed", "Error", **"RsltDtls"**: string, **"AddtlRsltInf"**: [ { **"Tp"**: string, **"Val"**: string } ] } | | No |
| ApprvlData | { **"ApprvlCd"**: string } | | No |
#### Ldgg Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Summry | { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string } | | No |
| LdggLineItm | [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] | | No |
#### tempdef46 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MOTOInd | boolean | Mail/Phone (MOTO) Boolean indicator distinguishing the type of mail or telephone order
*Example:* `true` | No |
| CardPres | boolean | Card Present
*Example:* `true` | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string } | | No |
| 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` | No |
| 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` | No |
| SpclConds | [ { **"Id"**: string } ] | | No |
| CrdhldrPres | boolean | Card Holder Present
*Example:* `true` | No |
| 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` | No |
| CardDataNtryMd | string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" | 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"` | No |
#### tempdef44 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | 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"` | No |
| Adr | { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string } | | No |
| URL | string | Contains acceptor URL address. | No |
| PhneNb | string | Contains acceptor phone number.
*Example:* `"4155551234"` | No |
| ShrtNm | string | Contains the name of the card acceptor (merchant)
*Example:* `"ABC Supplies"` | No |
| AddtlId | string | Unique identifier value assigned by Visa for each merchant included in the identification program
*Example:* `"52014057"` | No |
| PrtnrId | string | Contains acceptor partner ID code. | No |
| SvcLctn | { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string } | | No |
| AddtlIds | { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string } | | No |
| CstmrSvc | string | 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"` | No |
| AddtlData | { **"Tp"**: string, **"Val"**: string } | | No |
| BizRegnId | string | Contains acceptor business registration ID.
*Example:* `"123456789"` | No |
| LtdAccptnc | string | Indicates merchant limited accpetance information for MasterCard One Credential Exclusion. | No |
| BizRegnIdTp | string,
**Available values:** "00", "01", "02", "03", "04", "99" | 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"` | No |
| FrgnRtlrInd | boolean | Identifies a foreign retailer under a marketplace. DEfault value is false
*Example:* `false` | No |
| AddtlCtctInf | string | Contains acceptor additional contact information.
*Example:* `"4155551234"` | No |
| SpnsrdMrchnt | { **"Id"**: { **"Id"**: string } } | | No |
| PaymentFacltId | string | Payment Facilitator Identifier Identifies the marketplace or payment facilitator
*Example:* `"52014057"` | No |
#### tMessageIdentificationError Schema
Message identification and tracing elements.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reqstId | string | 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"` | No |
| correlatnId | string | correlatnId field must contain the same value as the original transaction being voided.
*Example:* `"12bc567d90f23e56a8f012"` | No |
#### tempdef43 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxId | { **"LclDtTm"**: string, **"AssctdTxLifeCyclId"**: string } | | No |
| AcctFr | { **"AcctId"**: string } | | No |
| TxAmts | { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] } | | No |
| TxAttr | [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ] | | No |
| TxSubTp | string | Business Application Identifier - CB Consumer Bill Payment
*Example:* `"CB"` | No |
| AddtlSvc | { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" } | | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string } | | No |
| AltrnMsgRsn | string | 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"` | No |
| SpclPrgrmmQlfctn | { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } | | No |
#### Fleetres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Summry | { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string } | | No |
| LineItm | [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] | 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. | No |
#### tempdef31 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Card | { **"PltfrmCd"**: string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT", **"CardSeqNb"**: string, **"PmtAccRef"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string, **"AddtlCardData"**: [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ], **"ReplacementPAN"**: string, **"PANFourLastDgts"**: string } | | No |
| Accptr | { **"Id"**: string, **"Adr"**: { **"AdrLine1"**: string }, **"URL"**: string, **"PhneNb"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"CEDPVrfd"**: string, **"CstmrSvc"**: string, **"BizRegnId"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"AddtlCtctInf"**: string } | | No |
| Termnl | { **"Tp"**: string, **"Cpblties"**: { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } } | | No |
| Crdhldr | { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } | | No |
#### CrdhldrPres Schema
Card Holder Present
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CrdhldrPres | boolean | Card Holder Present | |
**Example**
true
#### clientId Schema
Client Identification is a unique value assigned by Visa
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | Client Identification is a unique value assigned by Visa | |
**Example**
1VISAGCT000001
#### CountryCd Schema
Contains a country code for jurisdictions participating in domestic processing.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CountryCd | string | Contains a country code for jurisdictions participating in domestic processing. | |
**Example**
170
#### AdrLine1 Schema
Contains merchant street address.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AdrLine1 | string | Contains merchant street address. | |
#### tApprvlData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ApprvlCd | string | Authorization code from the issuer
*Example:* `"529801"` | No |
#### CtrySubDvsnMnr Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CtrySubDvsnMnr | string | 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
#### AttnddInd Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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
#### SubTp Schema
Account Entry Device Type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SubTp | string | Account Entry Device Type | |
#### FuelInd Schema
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”)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FuelInd | string,
**Available values:** "true", "false" | 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”) | |
**Example**
true
#### AddtlAccptrData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxRegnId | string | Merchant VAT Registration/ Single Business Reference Number
*Example:* `"123456789a123456789a"` | No |
#### SummryAddtlDataTpVal Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | Fuel Transaction Validation Results
*Example:* `"FuelTxValRslt"` | No |
| Val | string | Value for Fuel Transaction Validation Results
*Example:* `"12345"` | No |
#### AdddmDatares Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Cstmr | { **"RefNb"**: string, **"TxRegnId"**: string } | | No |
| Fleet | { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] } | | No |
| Instlmt | { **"Plan"**: [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ], **"PmtSeqNb"**: string } | | No |
| RcrngPmt | { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" } | | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string } | | No |
| AddtlAccptrData | { **"TxRegnId"**: string } | | No |
#### tRskAssmntArray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tRskAssmntArray | [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", **"AddtlRskData"**: { **"Tp"**: string, **"Val"**: string } } ] | | |
#### Dprture Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Dt | string | This value is the date of departure in mmddyy format.
*Example:* `"062524"` | No |
| Lctn | string | 3 character IATA airport code for the original departure location.
*Example:* `"ATL"` | No |
#### tempdef38 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tax | { **"Tp"**: string,
**Available values:** "VATA", **"Dcmnttn"**: string } | | No |
| TxId | { **"CardIssrRefData"**: string, **"LifeCyclIdVldtn"**: string } | | No |
| AcctFr | { **"AcctId"**: string, **"AcctTp"**: string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" } | | No |
| TxAmts | { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] } | | No |
| TxSubTp | string | Business Application Identifier - CB Consumer Bill Payment
*Example:* `"CB"` | No |
| AddtlSvc | [ { **"Tp"**: string,
**Available values:** "OTHP", "P001", **"Dtl"**: { **"AgeRslt"**: string, **"DOBRslt"**: string }, **"Rslt"**: string,
**Available values:** "PERF", "NOPF", "NOSP", "OTHP", **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId", **"OthrRslt"**: string } ] | | No |
| AddtlAmts | { **"Tp"**: string,
**Available values:** "AMTQ", **"Amt"**: { **"Amt"**: string, **"Ccy"**: string } } | | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string } | | No |
| AssoctdDataDstn | string | TC 50 Destination Identifier
*Example:* `"403456"` | No |
| SpclPrgrmmQlfctn | { **"IMP"**: string, **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ], **"Prgrmm"**: string, **"ApldSvc"**: string } | | No |
#### PAN Schema
Account number or token used in the transaction.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PAN | string | Account number or token used in the transaction. | |
**Example**
4234567890123456
#### tAddtlRsltInf1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | Type of Additional Result. Possible Values: Dupl, AcctStatus, VAURsnCd
*Example:* `"AcctStatus"` | No |
| Val | string | 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"` | No |
#### tempdef32 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Vrfctn | [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", "CRYP", "NVSC", "OTHP", **"VrfctnRslt"**: { **"Tp"**: string, **"Rslt"**: string,
**Available values:** "SUCC", "NOVF", "FAIL", "ERRR", "MISS", **"RsltDtls"**: string } } ] | *Example:* `[{"Tp":"THDS","VrfctnRslt":{"Tp":"authenticationValue","Rslt":"FAIL","RsltDtls":"0"}},{"Tp":"ADDB","VrfctnRslt":{"Rslt":"SUCC","RsltDtls":"A"}},{"Tp":"PCDV","VrfctnRslt":{"Rslt":"NOVF","RsltDtls":"R"}},{"Tp":"CSCV","VrfctnRslt":{"Rslt":"SUCC","RsltDtls":"M"}},{"VrfctnRslt":{"Tp":"DAF"}},{"VrfctnRslt":{"Tp":"CRYP","Rslt":"SUCC"}},{"Tp":"OTHP","VrfctnRslt":{"Tp":"AuthDataQualInd","RsltDtls":"1"}}]` | No |
| TxCntxt | { **"CaptrDt"**: string, **"AntcptdDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"XchgRateInf"**: [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ], **"PINPadInprtv"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string } | | No |
| RskCntxt | { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", "VAI" } ] } | | No |
| PtOfSvcCntxt | { **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"EComrcData"**: [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } | | No |
#### PrtnrId Schema
Contains acceptor partner ID code.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PrtnrId | string | Contains acceptor partner ID code. | |
#### GatewayData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AddtnlData | [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ] | | No |
| GatewayBrand | string,
**Available values:** "MSC", "AMX", "DSC" | Contains a Brand for GatewayData processing. Valid values: Mastercard - MSC, American Express - AMX, Discover - DSC
*Enum:* `"MSC"`, `"AMX"`, `"DSC"`
*Example:* `"MSC"` | No |
#### TaxTtl Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TaxXmptn | boolean | Miscellaneous Fuel Tax Exemption Status. true(Exempt), false(Non-exempt)
*Example:* `false` | No |
#### LineItmarrayres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SvcTp | string,
**Available values:** "FLSV", "SLSV" | Service Type. FLSV(Full service), SLSV(Self service)
*Enum:* `"FLSV"`, `"SLSV"`
*Example:* `"FLSV"` | No |
| FuelInd | string,
**Available values:** "true", "false" | 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"` | No |
| PdctQty | string | Quantity of fuel, non-fuel, or expanded non-fuel product purchased. Three Decimal Places are implied.
*Example:* `"25"` | No |
| UnitCost | [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ] | | No |
| FuelBrndCd | string | Fuel Brand
*Example:* `"CIRK"` | No |
| FleetPdctCd | string | Fuel or non-fuel product code. Fuel type codes are listed in Base II Clearing Data Codes document.
*Example:* `"1A"` | No |
| UnitOfMeasr | string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO" | 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"` | No |
| EFleetPdctCd | string | Expanded non-fuel type. Contains the purchased expanded non-fuel product code
*Example:* `"1A01"` | No |
#### TracData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TracData | { **"Tp"**: string, **"Val"**: string } | | No |
#### tRsltDtls Schema
Results of transaction request. M - CVV2/dCVV2 provided and matched, N - CVV2/dCVV2 provided and did not match, S - Required CVV2/dCVV2 information not provided, P - CVV2/dCVV2 not performed, U - Unable to Verify
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tRsltDtls | string | Results of transaction request. M - CVV2/dCVV2 provided and matched, N - CVV2/dCVV2 provided and did not match, S - Required CVV2/dCVV2 information not provided, P - CVV2/dCVV2 not performed, U - Unable to Verify | |
**Example**
00
#### CrdhldrAge Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DtOfBirth | string | Cardholder date of birth.
*Example:* `"1960-10-10"` | No |
#### VrfctnInf Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | Tp value for verification. Possible value is authenticationValue (3DS (3D Secure)) authentication performed during a secure electronic commerce transaction)
*Example:* `"authenticationValue"` | No |
| Rsn | string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard" | Value for CSCV Value not entered
*Enum:* `"Illegible"`, `"NotAttempted"`, `"NotOnCard"` | No |
| Val | { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } | | No |
#### tTxIdVoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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"` | No |
| AssctdTxLifeCyclId | string | Contains the Transaction Link Identifier from an economically related, independent transaction that a customer retains and returns in subsequent economically related transactions.
*Example:* `""` | No |
#### tTxAmts1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxAmt | { **"Amt"**: string, **"Ccy"**: string } | | No |
| DtldAmt | [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] | *Example:* `[{"Tp":"SRCH","Amt":"100.00"},{"Tp":"CSHB","Amt":"200.00"}]` | No |
#### GatewayDataResp Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AddtnlData | [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ] | | No |
| GatewayBrand | string,
**Available values:** "MSC", "AMX", "DSC" | Contains a Brand for GatewayData processing. Valid values: Mastercard - MSC, American Express - AMX, Discover - DSC
*Enum:* `"MSC"`, `"AMX"`, `"DSC"`
*Example:* `"MSC"` | No |
| SplmntryData | { **"TSPId"**: string, **"MsgClss"**: string, **"Termnltp"**: string, **"POSCondCd"**: string, **"ChipCondCd"**: string, **"RtrvlRefNb"**: string, **"TknRqstrId"**: string, **"SysTracAudtNb"**: string, **"TrnsmssnDtTm "**: string, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" } | SplmntryData for GatewayData. Contains supplementary data fields | No |
#### tTxAmts2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxAmt | { **"Amt"**: string, **"Ccy"**: string } | | No |
| AmtQlfr | string | 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"` | No |
| DtldAmt | [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] | *Example:* `[{"Tp":"SRCH","Amt":"100.00"},{"Tp":"CSHB","Amt":"200.00"}]` | No |
#### LtdAccptnc Schema
Indicates merchant limited accpetance information for MasterCard One Credential Exclusion.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LtdAccptnc | string | Indicates merchant limited accpetance information for MasterCard One Credential Exclusion. | |
#### PstlCd Schema
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
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PstlCd | string | 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
#### Vhcl Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Odmtr | string | Odometer Reading
*Example:* `"120"` | No |
| TrlrNb | string | Fleet Trailer Number. Contains the trailer number for the Visa Fleet cardholder or vehicle-assigned card.
*Example:* `"123456789iururei"` | No |
| FleetNb | string | Fleet Number
*Example:* `"1234567h"` | No |
| VhclIdNb | string | Vehicle Registration Number
*Example:* `"123456789asdfg"` | No |
#### tRslt Schema
Verification result. SUCC - Success, NOVF - Unable to verify, FAIL - Failure, ERRR - Error in verifying, MISS - Missing required value
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tRslt | string,
**Available values:** "SUCC", "NOVF", "FAIL", "ERRR", "MISS" | Verification result. SUCC - Success, NOVF - Unable to verify, FAIL - Failure, ERRR - Error in verifying, MISS - Missing required value | |
#### CstmrSvc Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CstmrSvc | string | 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
#### GatewaySplmntryData Schema
SplmntryData for GatewayData. Contains supplementary data fields
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TSPId | string | Token Requestor - Token Service Provider ID
*Example:* `"00000040293"` | No |
| MsgClss | string | contains the 4-digit message type identifier from the original message.
*Example:* `"0200"` | No |
| Termnltp | string | 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"` | No |
| POSCondCd | string | contains a code identifying transaction conditions at the point-of-sale or point of service. For messages that follow an original request, this code identifies the type of processing being done.
*Example:* `"59"` | No |
| ChipCondCd | string | Chip Condition Code
*Example:* `"0"` | No |
| RtrvlRefNb | string | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.
*Example:* `"300920871687"` | No |
| TknRqstrId | string | Token Requestor ID
*Example:* `"40010030273"` | No |
| SysTracAudtNb | string | This field contains a number assigned by the message initiator that uniquely identifies a cardholder transaction and all message types
*Example:* `"871687"` | No |
| TrnsmssnDtTm | 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"` | No |
| CardDataNtryMd | string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" | 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"` | No |
| CardRdngCpblty | string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" | 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"` | No |
#### tMessageIdentificationVoidReq Schema
Message identification and tracing elements.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| clientId | string | Client Identification is a unique value assigned by Visa
*Example:* `"1VISAGCT000001"` | No |
| correlatnId | string | correlatnId field must contain the same value as the original transaction being voided.
*Example:* `"12bc567d90f23e56a8f012"` | No |
#### authorizations_void Schema
Used to void an "Authorization" resource
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Hdr | { **"NttyId"**: string, **"TracData"**: { **"Tp"**: string, **"Val"**: string } } | | No |
| Body | { **"Tx"**: { **"TxId"**: { **"LclDtTm"**: string, **"AssctdTxLifeCyclId"**: string }, **"AcctFr"**: { **"AcctId"**: string }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxAttr"**: [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ], **"TxSubTp"**: string, **"AddtlSvc"**: { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AltrnMsgRsn"**: string, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } }, **"Envt"**: { **"Card"**: { **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"SchmeId"**: string, **"CardSeqNb"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"SaleCntxt"**: { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" }, **"PtOfSvcCntxt"**: { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: [ { **"Id"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"NtlData"**: { **"Ctry"**: string, **"VATRate"**: string, **"IRFIndicator"**: string,
**Available values:** "D", "S", **"InstlmtPmtNb"**: string, **"InstlmtPmtInd"**: string, **"NbOfInstlmtPmts"**: string, **"InstlmtPmtIntrstSttlmInd"**: string,
**Available values:** "A", "D" }, **"NtnlData"**: { **"CountryCd"**: string, **"SpainData"**: [ { **"LclAccptrId"**: string, **"LclMrchntCtgyCd"**: string } ], **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC", **"Val"**: string } ] }, **"AdddmData"**: { **"Ldgg"**: { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] }, **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"TrvlAgcy"**: { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } }, **"VhclRntl"**: { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"PurchsIdr"**: string, **"PurchsIdrTp"**: string,
**Available values:** "ORNU", "REAG", "FONU", **"PssngrTrnsprt"**: { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } } ] } | | No |
| msgIdentfctn | { **"clientId"**: string, **"correlatnId"**: string } | Message identification and tracing elements. | No |
#### tAddtlAmts Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "AMTQ" | Contains transaction additional amount type. Possible values are AMTQ - Requested amount (Transaction amount that has been requested to be authorized)
*Enum:* `"AMTQ"`
*Example:* `"AMTQ"` | No |
| Amt | { **"Amt"**: string, **"Ccy"**: string } | | No |
#### tRskAssmnt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Rslt | string | Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring
*Example:* `"UnreliableICVV"` | No |
| RskAssmntTp | string,
**Available values:** "MSI", "VTA" | Risk assessment type.
*Enum:* `"MSI"`, `"VTA"` | No |
| AddtlRskData | { **"Tp"**: string, **"Val"**: string } | | No |
#### authCapture Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| href | object | Hypermedia links.
*Example:* `"https://sandbox.api.visa.com/acs/v3/payments/authorizations/123456789012345/captures"` | No |
#### TxAttr Schema
Contains Transaction Attribute Type.Possible values: INST (Installment payment), RCPT (Recurring payment), DBRP (Debt repayment), UCOF (Unscheduled Credentials on File), MOTO (Mail Order/Telephone Order), DFRD (Deferred), PAUT(Pre-Authorisation).
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxAttr | string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" | Contains Transaction Attribute Type.Possible values: INST (Installment payment), RCPT (Recurring payment), DBRP (Debt repayment), UCOF (Unscheduled Credentials on File), MOTO (Mail Order/Telephone Order), DFRD (Deferred), PAUT(Pre-Authorisation). | |
**Example**
RCPT
#### NbOfPmt Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NbOfPmt | string | 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
#### CrdhldrVrfctnCpblty Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Cpblty | string,
**Available values:** "UNSP", "NPIN", "NOOP" | 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"` | No |
#### PdctQty Schema
Quantity of fuel, non-fuel, or expanded non-fuel product purchased. Three Decimal Places are implied.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PdctQty | string | Quantity of fuel, non-fuel, or expanded non-fuel product purchased. Three Decimal Places are implied. | |
**Example**
25
#### PINPadInprtv Schema
Contains a PIN Pad indicator which is used to indicate whether or not the PIN pad is operative.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PINPadInprtv | boolean | Contains a PIN Pad indicator which is used to indicate whether or not the PIN pad is operative. | |
**Example**
false
#### authorizations_void_id Schema
Used to void an "Authorization" resource
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Hdr | { **"NttyId"**: string, **"TracData"**: { **"Tp"**: string, **"Val"**: string } } | | No |
| Body | { **"Tx"**: { **"TxId"**: { **"LclDtTm"**: string, **"AssctdTxLifeCyclId"**: string }, **"AcctFr"**: { **"AcctId"**: string }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxAttr"**: [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ], **"TxSubTp"**: string, **"AddtlSvc"**: { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AltrnMsgRsn"**: string, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } }, **"Envt"**: { **"Card"**: { **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"SchmeId"**: string, **"CardSeqNb"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"SaleCntxt"**: { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" }, **"PtOfSvcCntxt"**: { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: [ { **"Id"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"NtlData"**: { **"Ctry"**: string, **"VATRate"**: string, **"IRFIndicator"**: string,
**Available values:** "D", "S", **"InstlmtPmtNb"**: string, **"InstlmtPmtInd"**: string, **"NbOfInstlmtPmts"**: string, **"InstlmtPmtIntrstSttlmInd"**: string,
**Available values:** "A", "D" }, **"NtnlData"**: { **"CountryCd"**: string, **"SpainData"**: [ { **"LclAccptrId"**: string, **"LclMrchntCtgyCd"**: string } ], **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC", **"Val"**: string } ] }, **"AdddmData"**: { **"Ldgg"**: { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] }, **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"TrvlAgcy"**: { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } }, **"VhclRntl"**: { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"PurchsIdr"**: string, **"PurchsIdrTp"**: string,
**Available values:** "ORNU", "REAG", "FONU", **"PssngrTrnsprt"**: { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC" }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } } ] } | | No |
| msgIdentfctn | { **"clientId"**: string, **"correlatnId"**: string } | Message identification and tracing elements. | No |
#### tAddtlRsltInf Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tAddtlRsltInf | [ { **"Tp"**: string, **"Val"**: string } ] | | |
#### 200_authorizations Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Hdr | { **"TracData"**: { **"Tp"**: string, **"Val"**: string } } | | No |
| Body | { **"Tx"**: { **"Tax"**: { **"Tp"**: string,
**Available values:** "VATA", **"Dcmnttn"**: string }, **"TxId"**: { **"CardIssrRefData"**: string, **"LifeCyclIdVldtn"**: string }, **"AcctFr"**: { **"AcctId"**: string, **"AcctTp"**: string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxSubTp"**: string, **"AddtlSvc"**: [ { **"Tp"**: string,
**Available values:** "OTHP", "P001", **"Dtl"**: { **"AgeRslt"**: string, **"DOBRslt"**: string }, **"Rslt"**: string,
**Available values:** "PERF", "NOPF", "NOSP", "OTHP", **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId", **"OthrRslt"**: string } ], **"AddtlAmts"**: { **"Tp"**: string,
**Available values:** "AMTQ", **"Amt"**: { **"Amt"**: string, **"Ccy"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AssoctdDataDstn"**: string, **"SpclPrgrmmQlfctn"**: { **"IMP"**: string, **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ], **"Prgrmm"**: string, **"ApldSvc"**: string } }, **"Envt"**: { **"Card"**: { **"PltfrmCd"**: string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT", **"CardSeqNb"**: string, **"PmtAccRef"**: string, **"CardPdctTp"**: string, **"CardPrtflIdr"**: string, **"AddtlCardData"**: [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ], **"ReplacementPAN"**: string, **"PANFourLastDgts"**: string }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"AdrLine1"**: string }, **"URL"**: string, **"PhneNb"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"CEDPVrfd"**: string, **"CstmrSvc"**: string, **"BizRegnId"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"AddtlCtctInf"**: string }, **"Termnl"**: { **"Tp"**: string, **"Cpblties"**: { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", "CRYP", "NVSC", "OTHP", **"VrfctnRslt"**: { **"Tp"**: string, **"Rslt"**: string,
**Available values:** "SUCC", "NOVF", "FAIL", "ERRR", "MISS", **"RsltDtls"**: string } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"AntcptdDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"XchgRateInf"**: [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ], **"PINPadInprtv"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"RskCntxt"**: { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", "VAI" } ] }, **"PtOfSvcCntxt"**: { **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"EComrcData"**: [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } }, **"PrcgRslt"**: { **"RsltData"**: { **"Rslt"**: string,
**Available values:** "Approved", "PartiallyApproved", "NoReasonToDecline", "Declined", "Error", **"RsltDtls"**: string, **"AddtlRsltInf"**: [ { **"Tp"**: string, **"Val"**: string } ] }, **"ApprvlData"**: { **"ApprvlCd"**: string } }, **"AdddmData"**: { **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC", **"SplmntryData"**: { **"TSPId"**: string, **"MsgClss"**: string, **"Termnltp"**: string, **"POSCondCd"**: string, **"ChipCondCd"**: string, **"RtrvlRefNb"**: string, **"TknRqstrId"**: string, **"SysTracAudtNb"**: string, **"TrnsmssnDtTm "**: string, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" } }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string, **"RsnNotHnrd"**: string } ], **"DlgtdAuthrty"**: string } } ] } | | No |
| _links | { **"authVoid"**: { **"href"**: object }, **"authCapture"**: { **"href"**: object } } | | No |
| msgIdentfctn | { **"id"**: string, **"reqstId"**: string, **"correlatnId"**: string } | Message identification and tracing elements. | No |
#### Ctry Schema
The 2-character, uppercase alpha code for the country where the customer transaction occurs
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Ctry | string | The 2-character, uppercase alpha code for the country where the customer transaction occurs | |
**Example**
US
#### InstlmtCcy Schema
Currency code associated with the instalment amount. ISO 4217 "Codes for the representation of currencies and funds".
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| InstlmtCcy | string | Currency code associated with the instalment amount. ISO 4217 "Codes for the representation of currencies and funds". | |
**Example**
840
#### TxRltdData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tax | [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ] | | No |
| TaxTtl | { **"TaxXmptn"**: boolean } | | No |
| PurchsTp | string,
**Available values:** "FUEL", "NONF", "FANF" | Type of Purchase FUEL(Fuel purchase), NONF(Non-Fuel purchase), FANF(Fuel and Non-Fuel purchase)
*Enum:* `"FUEL"`, `"NONF"`, `"FANF"`
*Example:* `"FUEL"` | No |
| SummryCmmdtyId | string | Summary Commodity Code
*Example:* `"1234"` | No |
#### CrdhldrActvtd Schema
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.)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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
#### tmsg Schema
Message providing more details about the error
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tmsg | string | Message providing more details about the error | |
**Example**
Invalid Primary Account
#### PctTtlFees Schema
Percent of Total Fees
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PctTtlFees | string | Percent of Total Fees | |
**Example**
4
#### tAccptr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | 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"` | No |
| Adr | { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string } | | No |
| URL | string | Contains acceptor URL address. | No |
| PhneNb | string | Contains acceptor phone number.
*Example:* `"4155551234"` | No |
| ShrtNm | string | Contains the name of the card acceptor (merchant)
*Example:* `"ABC Supplies"` | No |
| AddtlId | string | Unique identifier value assigned by Visa for each merchant included in the identification program
*Example:* `"52014057"` | No |
| PrtnrId | string | Contains acceptor partner ID code. | No |
| SvcLctn | { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string } | | No |
| AddtlIds | { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string } | | No |
| CstmrSvc | string | 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"` | No |
| PrvtData | { **"GtwyMrchntData"**: string } | | No |
| AddtlData | { **"Tp"**: string, **"Val"**: string } | | No |
| BizRegnId | string | Contains acceptor business registration ID.
*Example:* `"123456789"` | No |
| LtdAccptnc | string | Indicates merchant limited accpetance information for MasterCard One Credential Exclusion. | No |
| BizRegnIdTp | string,
**Available values:** "00", "01", "02", "03", "04", "99" | 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"` | No |
| FrgnRtlrInd | boolean | Identifies a foreign retailer under a marketplace. DEfault value is false
*Example:* `false` | No |
| AddtlCtctInf | string | Contains acceptor additional contact information.
*Example:* `"4155551234"` | No |
| SpnsrdMrchnt | { **"Id"**: { **"Id"**: string } } | | No |
| PaymentFacltId | string | Payment Facilitator Identifier Identifies the marketplace or payment facilitator
*Example:* `"52014057"` | No |
#### RskAssmntRsltRes Schema
Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring. Or VAI Visa Account Attack Intelligence Score
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RskAssmntRsltRes | string | Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring. Or VAI Visa Account Attack Intelligence Score | |
**Example**
UnreliableICVV
#### LocalDateTime Schema
Local date and time the transaction takes place at the card acceptor location. Format is ISO 8601 (YYYY-MM-DDThh:mm:ss)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LocalDateTime | 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
#### MrchntVolInd Schema
Merchant Volume Indicator. The only allowed value for this tag is '01'. The request value will override what is in the profile.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MrchntVolInd | string | Merchant Volume Indicator. The only allowed value for this tag is '01'. The request value will override what is in the profile. | |
**Example**
01
#### ICCFllbckInd Schema
Chip Condition Code
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ICCFllbckInd | string | Chip Condition Code | |
**Example**
0
#### XpryDt Schema
Expiration date of the account number or token in YYMM format.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| XpryDt | string | Expiration date of the account number or token in YYMM format. | |
**Example**
2212
#### TrvlAgcy Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Cpny | { **"Cd"**: string, **"Nm"**: string } | | No |
#### PreAuthstnTmLmt Schema
Preauth Time Limit in minutes.This field contains the time an issuer agrees to hold funds for an acquirer requesting an 0100 preauthorization. This field applies to preauthorizations and completions only.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PreAuthstnTmLmt | string | Preauth Time Limit in minutes.This field contains the time an issuer agrees to hold funds for an acquirer requesting an 0100 preauthorization. This field applies to preauthorizations and completions only. | |
**Example**
12
#### PINLngthCpblties Schema
Maximum number of PIN characters that can be accepted by the point-of-service device
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PINLngthCpblties | string | Maximum number of PIN characters that can be accepted by the point-of-service device | |
**Example**
05
#### GracePrd Schema
Grace Period. Contains number of months from 00-99 that the payment is not required.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GracePrd | string | Grace Period. Contains number of months from 00-99 that the payment is not required. | |
**Example**
02
#### authorizations Schema
Used for new "Authorizations" resource requests
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Hdr | { **"NttyId"**: string, **"TracData"**: { **"Tp"**: string, **"Val"**: string } } | | No |
| Body | { **"Tx"**: { **"Tax"**: { **"Tp"**: string,
**Available values:** "LOCL", "VATA", **"Amt"**: string, **"Dcmnttn"**: string }, **"TxId"**: { **"LclDtTm"**: string }, **"AcctFr"**: { **"AcctId"**: string }, **"TxAmts"**: { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] }, **"TxAttr"**: [ string,
**Available values:** "INST", "RCPT", "DBRP", "UCOF", "MOTO", "DFRD", "PAUT" ], **"TxDesc"**: string, **"TxSubTp"**: string, **"AddtlSvc"**: [ { **"Tp"**: string,
**Available values:** "DCCV", "OTHP", **"Dtl"**: { **"AgeVrfctnReqData"**: string }, **"Val"**: string, **"OthrTp"**: string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" } ], **"AddtlData"**: { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string }, **"AltrnMsgRsn"**: string, **"PreAuthstnTmLmt"**: string, **"SpclPrgrmmQlfctn"**: { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ], **"Prgrmm"**: string } }, **"Envt"**: { **"Card"**: { **"PAN"**: string, **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"XpryDt"**: string, **"SchmeId"**: string, **"CardSeqNb"**: string }, **"Wllt"**: { **"Prvdr"**: { **"Id"**: string,
**Available values:** "VCIND" } }, **"Accptr"**: { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"PrvtData"**: { **"GtwyMrchntData"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string }, **"Termnl"**: { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } }, **"Crdhldr"**: { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } }, **"Cntxt"**: { **"Vrfctn"**: [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ], **"TxCntxt"**: { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string }, **"RskCntxt"**: { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA" } ] }, **"SaleCntxt"**: { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" }, **"PtOfSvcCntxt"**: { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: { **"Id"**: string }, **"EComrcData"**: [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"PrtlApprvlSpprtd"**: boolean } }, **"NtlData"**: { **"Ctry"**: string, **"VATRate"**: string, **"IRFIndicator"**: string,
**Available values:** "D", "S", **"InstlmtPmtNb"**: string, **"InstlmtPmtInd"**: string, **"NbOfInstlmtPmts"**: string, **"InstlmtPmtIntrstSttlmInd"**: string,
**Available values:** "A", "D" }, **"NtnlData"**: { **"CountryCd"**: string, **"SpainData"**: [ { **"LclAccptrId"**: string, **"LclMrchntCtgyCd"**: string } ], **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC", **"Val"**: string } ] }, **"AdddmData"**: { **"Ldgg"**: { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] }, **"Cstmr"**: { **"RefNb"**: string, **"TxRegnId"**: string }, **"Fleet"**: { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] }, **"Instlmt"**: { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string }, **"RcrngPmt"**: { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" }, **"TrvlAgcy"**: { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } }, **"VhclRntl"**: { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"Drtn"**: string, **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } }, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string }, **"PurchsIdr"**: string, **"PurchsIdrTp"**: string,
**Available values:** "ORNU", "REAG", "FONU", **"PssngrTrnsprt"**: { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] }, **"AddtlAccptrData"**: { **"TxRegnId"**: string } }, **"PrtctdData"**: { **"NcrptdData"**: { **"Algo"**: string,
**Available values:** "TDEA", "AES", **"Ctrl"**: string,
**Available values:** "DUKPT", "ZCK", **"DrvdInf"**: string, **"KeyIndx"**: string, **"KeySetIdr"**: string, **"PINBlckFrmt"**: string, **"NcrptdPINBlck"**: string } }, **"GatewayData"**: { **"AddtnlData"**: [ { **"Tp"**: string,
**Available values:** "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", **"Val"**: string } ], **"GatewayBrand"**: string,
**Available values:** "MSC", "AMX", "DSC" }, **"ICCRltdData"**: string, **"SplmtryData"**: [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } } ] } | | No |
| msgIdentfctn | { **"origId"**: string, **"clientId"**: string, **"correlatnId"**: string } | | Yes |
#### AddtlSvcRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "OTHP", "P001" | OTHP - Other Value. P001 - MDES Service Indicator
*Enum:* `"OTHP"`, `"P001"`
*Example:* `"OTHP"` | No |
| Dtl | { **"AgeRslt"**: string, **"DOBRslt"**: string } | | No |
| Rslt | string,
**Available values:** "PERF", "NOPF", "NOSP", "OTHP" | Account name request result. PERF: performed, NOPF: not performef, NOSP: not supported. Or OTHP for other values
*Enum:* `"PERF"`, `"NOPF"`, `"NOSP"`, `"OTHP"`
*Example:* `"PERF"` | No |
| OthrTp | string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" | Transaction ID Service Instruction. StoreTxId – Store transaction ID ,RetrieveTxId – Retrieve transaction ID ,StoreRetrieveTxId – Save/Retrieve
*Enum:* `"StoreTxId"`, `"RetrieveTxId"`, `"StoreRetrieveTxId"`
*Example:* `"StoreTxId"` | No |
| OthrRslt | string | Tran ID Service Result. Contains one of the following values when the acquirer requests the storage or retrieval of the original transaction details in the request message: 01 (Transaction ID stored successfully), 02 (Transaction ID not stored), 03 (Transaction ID retrieved successfully), 04 (Transaction ID not found/retrieved)
*Example:* `"01"` | No |
**Example**
{
"Tp": "OTHP",
"Rslt": "OTHP",
"OthrTp": "StoreTxId",
"OthrRslt": "01"
}
#### LclMrchntCtgyCd Schema
Contains the domestic MCC when it differs from the international MCC
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LclMrchntCtgyCd | string | Contains the domestic MCC when it differs from the international MCC | |
**Example**
6010
#### tCardC Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Trck1 | string | 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"` | No |
| Trck2 | { **"HexBinryVal"**: string } | | No |
| SchmeId | string | Contains the card scheme selected for the transaction 01(Visa), 02(Others)
*Example:* `"01"` | No |
| CardSeqNb | string | A number assigned to a card when two or more individual cards are associated with the same primary account number
*Example:* `"0200"` | No |
| CardPdctTp | string | Contains a product ID.
*Example:* `"G1"` | No |
| CardPrtflIdr | string | Contains a program identification number used with a product ID attribute
*Example:* `"ABCD12"` | No |
#### tTxCntxt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CaptrDt | string | Capture Date in the format MMDD
*Example:* `"0421"` | No |
| CardPrgrmm | { **"CardPrgrmmApld"**: { **"Id"**: string } } | | No |
| ICCFllbckInd | string | Chip Condition Code
*Example:* `"0"` | No |
| MrchntCtgyCd | integer | 4-digit Merchant Category Code (ISO 18245)
*Example:* `4814` | No |
| MrchntVolInd | string | Merchant Volume Indicator. The only allowed value for this tag is '01'. The request value will override what is in the profile.
*Example:* `"01"` | No |
| PINPadInprtv | boolean | Contains a PIN Pad indicator which is used to indicate whether or not the PIN pad is operative.
*Example:* `false` | No |
| AuthntcnOutgInd | boolean | SCA Outage Indicator
*Example:* `true` | No |
| MgntcStrpFllbckInd | boolean | Magnetic Strip Fallback Indicator
*Example:* `true` | No |
| MrchntCtgySpcfcData | string | Market-Specific Data Identifier
*Example:* `"B"` | No |
#### PerTxAmtTp Schema
Payment Amount Indicator Per Transaction. 1(Fixed amount Recurring Payment), 2(Recurring Payment with maximum amount)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PerTxAmtTp | string,
**Available values:** "1", "2" | Payment Amount Indicator Per Transaction. 1(Fixed amount Recurring Payment), 2(Recurring Payment with maximum amount) | |
**Example**
1
#### CtrySubDvsnMjr Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CtrySubDvsnMjr | string | 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
#### NttyId Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NttyId | string | 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
#### TtlExpnss Schema
Total Expenses
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlExpnss | string | Total Expenses | |
**Example**
23.00
#### RcrngPmtTp Schema
Recurring Payment Type. 1(Registration/first transaction), 2(Subsequent transaction), 3(Modification), 4(Cancellation)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RcrngPmtTp | string,
**Available values:** "1", "2", "3", "4" | Recurring Payment Type. 1(Registration/first transaction), 2(Subsequent transaction), 3(Modification), 4(Cancellation) | |
**Example**
1
#### PctTtlOtherCost Schema
Percent of Total Other Costs
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PctTtlOtherCost | string | Percent of Total Other Costs | |
**Example**
3
#### CardPres Schema
Card Present
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardPres | boolean | Card Present | |
**Example**
true
#### EComrcInd Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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
#### origId Schema
Original resource identifier from related transaction for reauthorization, recurring or installment payments.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| origId | string | Original resource identifier from related transaction for reauthorization, recurring or installment payments. | |
**Example**
123451234567890
#### tCard1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| XpryDt | string | Expiration date of the account number or token in YYMM format.
*Example:* `"2212"` | No |
| PltfrmCd | string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT" | 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"` | No |
| CardSeqNb | string | A number assigned to a card when two or more individual cards are associated with the same primary account number
*Example:* `"0200"` | No |
| PmtAccRef | string | 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"` | No |
| CardPdctTp | string | Contains a product ID.
*Example:* `"G1"` | No |
| CardPrtflIdr | string | Contains a program identification number used with a product ID attribute
*Example:* `"ABCD12"` | No |
| AddtlCardData | [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ] | *Example:* `[{"Tp":"AcctFndgSrc","Val":"CRDT"}]` | No |
| ReplacementPAN | string | Replacement PAN if new PAN requested / Replacement account number provided by Real Time VAU
*Example:* `"4234567890123456"` | No |
#### tmsgIdentfctn1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| origId | string | Original resource identifier from related transaction for reauthorization, recurring or installment payments.
*Example:* `"123451234567890"` | No |
| clientId | string | Client Identification is a unique value assigned by Visa
*Example:* `"1VISAGCT000001"` | No |
| correlatnId | string | correlatnId field must contain the same value as the original transaction being voided.
*Example:* `"12bc567d90f23e56a8f012"` | No |
#### GoodsAndSvcsSubTp Schema
Possible Value - CRCU: Cryptocurrency purchase
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GoodsAndSvcsSubTp | string,
**Available values:** "CRCU" | Possible Value - CRCU: Cryptocurrency purchase | |
**Example**
CRCU
#### Taxarray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR" | 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"` | No |
| Amt | string | Tax Amount. Two decimal places are implied. Only applicable to “Tp” values “LOCI”, “NATI”, and “OTHR”
*Example:* `"100.00"` | No |
| Rate | string | Tax Rate. Two decimal places are implied. Only applicable to “Tp” values “VATA” and “OTHR
*Example:* `"1.00"` | No |
| InclInTtlInd | string,
**Available values:** "true", "false" | 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"` | No |
#### SplmtryDataArrayRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| StrngCstmrAuthntcn | { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string, **"RsnNotHnrd"**: string } ], **"DlgtdAuthrty"**: string } | | No |
#### PurchsIdr Schema
Identifies the purchase to the issuer and cardholder such as order number for card not present transactions
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PurchsIdr | string | Identifies the purchase to the issuer and cardholder such as order number for card not present transactions | |
**Example**
0123-23
#### SplmtryDataArrayReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| StrngCstmrAuthntcn | { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } | | No |
#### TransactionDtlArrayRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgeRslt | string | Age verification result.
*Example:* `"VVVVV"` | No |
| DOBRslt | string | Date of birth verification result.
*Example:* `"M"` | No |
#### PrvtData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GtwyMrchntData | string | Gateway Merchant Data Bank ABA number.
*Example:* `"V070990024552"` | No |
#### tVrfctn1Res Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", "CRYP", "NVSC", "OTHP" | Type of verification requested. Valid values: NVSC – NonVisibleCSC; CVV/iCCV results, CRYP – CryptogramVerification; Card authentication results code, THDS – 3D Secure, ADDB – Billing address verification, PCDV – Postal code, CSCV – CSC verification, OTHP - Authentication Data Quality Indicator.
*Enum:* `"THDS"`, `"ADDB"`, `"PCDV"`, `"CSCV"`, `"CRYP"`, `"NVSC"`, `"OTHP"`
*Example:* `"THDS"` | No |
| VrfctnRslt | { **"Tp"**: string, **"Rslt"**: string,
**Available values:** "SUCC", "NOVF", "FAIL", "ERRR", "MISS", **"RsltDtls"**: string } | | No |
#### LdggSummry Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Drtn | string | For Rental it contains duration of rental in days.
*Example:* `"01"` | No |
| Arrvl | { **"Dt"**: string } | | No |
| RoomRt | string | Contains the daily rate being charged for the room. No decimal points should be used. Two decimal places are implied.
*Example:* `"2000"` | No |
| TtlTax | string | 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"` | No |
| RoomNite | string | Contains the total number of nights being billed.
*Example:* `"01"` | No |
| 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` | No |
| TtlRoomTax | string | Contains the room tax that is being billed. No decimal points should be used. Two decimal places are implied.
*Example:* `"1000"` | No |
#### TxIdresAuth Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardIssrRefData | string | Gateway Transaction ID
*Example:* `"1234567"` | No |
| LifeCyclIdVldtn | string | Contains the validation result captured by Mastercard. Values: 1 - The customer did not provide the TLID, 2 - The TLID provided by customer is unmatched. Contains the customer-provided TLID.
*Example:* `""` | No |
#### TransactionDtlArrayReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgeVrfctnReqData | string | Age verification request data.
*Example:* `"12D25D35D45D50D"` | No |
#### XchgRate Schema
the rate used by VisaNet to convert the transaction amount to the cardholder billing amount
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| XchgRate | string | the rate used by VisaNet to convert the transaction amount to the cardholder billing amount | |
**Example**
99801539
#### tEComrcData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tEComrcData | [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ] | | |
**Example**
[
{
"Tp": "ECI",
"Val": "5"
},
{
"Tp": "XID",
"Val": "EEC4567F90123A5678B0123EA67890D2345678FF"
}
]
#### Cpblty Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Cpblty | string,
**Available values:** "UNSP", "NPIN", "NOOP" | 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. | |
**Example**
NOOP
#### EvSpecificarray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp" | 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"` | No |
| Val | string | Value for the Ev Specific type given in Tp
*Example:* `"100.00"` | No |
#### TtlNbOfPmts Schema
Total number of installment payments.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlNbOfPmts | string | Total number of installment payments. | |
**Example**
50
#### CrdhldrId Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| IdCd | string | Contains the Identification Type Code.
*Example:* `"TXIN"` | No |
| IdVal | string | Contains the Identification Value.
*Example:* `"12345"` | No |
| IdSubCd | string | Contains the Identification Subtype Code. 0B-Business, 0I-Individual
*Example:* `"0B"` | No |
| AssgnrAuthrty | { **"Ctry"**: string } | | No |
#### EvChargInd Schema
Electric Vehicle Charging Indicator. This indicator should be included in every instance of LineItm that has EV fields
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| EvChargInd | string,
**Available values:** "true", "false" | Electric Vehicle Charging Indicator. This indicator should be included in every instance of LineItm that has EV fields | |
**Example**
true
#### PurchsIdrTp Schema
Purchase identifier type. Purchase identifier type is required in the U.S. Valid values: “ORNU” (Order number), “REAG” (Rental agreement),“FONU” (Folio number)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PurchsIdrTp | string,
**Available values:** "ORNU", "REAG", "FONU" | Purchase identifier type. Purchase identifier type is required in the U.S. Valid values: “ORNU” (Order number), “REAG” (Rental agreement),“FONU” (Folio number) | |
**Example**
ORNU
#### rPAN Schema
Replacement PAN if new PAN requested / Replacement account number provided by Real Time VAU
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| rPAN | string | Replacement PAN if new PAN requested / Replacement account number provided by Real Time VAU | |
**Example**
4234567890123456
#### Val Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxtVal | string | Value for ADDB, PCDV, CSCV, DRIV, PASN, NTID, TXIN Validation | No |
| PINData | { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string } | Security Related Control Information | No |
| HexBinryVal | string | Cardholder Authentication Verification Value. (THDS/3DS)
*Example:* `"0000010679579169514231801557910000000000"` | No |
#### PrdUnit Schema
Period unit between consecutive payments
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PrdUnit | string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN" | Period unit between consecutive payments | |
**Example**
WEEK
#### CardSeqNb Schema
A number assigned to a card when two or more individual cards are associated with the same primary account number
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardSeqNb | string | A number assigned to a card when two or more individual cards are associated with the same primary account number | |
**Example**
0200
#### LineItmarray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SvcTp | string,
**Available values:** "FLSV", "SLSV" | Service Type. FLSV(Full service), SLSV(Self service)
*Enum:* `"FLSV"`, `"SLSV"`
*Example:* `"FLSV"` | No |
| FuelInd | string,
**Available values:** "true", "false" | 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"` | No |
| PdctQty | string | Quantity of fuel, non-fuel, or expanded non-fuel product purchased. Three Decimal Places are implied.
*Example:* `"25"` | No |
| UnitCost | [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ] | | No |
| EvChargInd | string,
**Available values:** "true", "false" | Electric Vehicle Charging Indicator. This indicator should be included in every instance of LineItm that has EV fields
*Enum:* `"true"`, `"false"`
*Example:* `"true"` | No |
| EvSpecific | [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ] | | No |
| FuelBrndCd | string | Fuel Brand
*Example:* `"CIRK"` | No |
| FleetPdctCd | string | Fuel or non-fuel product code. Fuel type codes are listed in Base II Clearing Data Codes document.
*Example:* `"1A"` | No |
| UnitOfMeasr | string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO" | 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"` | No |
| EFleetPdctCd | string | Expanded non-fuel type. Contains the purchased expanded non-fuel product code
*Example:* `"1A01"` | No |
#### SvcLctn Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Ctry | string | Contains acceptor service location country code. | No |
| TwnNm | string | Contains acceptor service location city name.
*Example:* `"San Francisco"` | No |
| PstlCd | string | Contains acceptor service location postal code.
*Example:* `"94105"` | No |
| AdrLine1 | string | Contains acceptor service location street address.
*Example:* `"1000 Main Street"` | No |
| CtrySubDvsnMjr | string | Contains acceptor service location state/province code. | No |
#### UnitCostarray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP" | 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"` | No |
| Val | string | 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"` | No |
#### tSpclPrgrmmQlfctn Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Dtls | [ { **"Nm"**: string,
**Available values:** "ACI", "ReqPmtSvc", "MVV", "SPEND", "RmbrsmntAttr", "EVV", **"Val"**: string } ] | *Example:* `[{"Nm":"ACI","Val":"Y"}]` | No |
| Prgrmm | string | Specifies the name of the special incentive program. Only Valid Value is CPS (Custom Payment Service)
*Example:* `"CPS"` | No |
#### Instlmt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Plan | [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ] | | No |
| PmtSeqNb | string | Payment Sequence Number
*Example:* `"20"` | No |
#### tAcctFr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AcctId | string | Account Identification 1
*Example:* `"0000305071"` | No |
#### LdggLineItm Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LdggLineItm | [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] | | |
#### EComrcData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "ECI", "XID" | ECI - Level of security used in an electronic commerce transaction. If none provided for eCom transactions, the default value of 7 is used in the request. XID - contains a unique Visa Secure Electronic Commerce (VSEC) number-the transaction ID or XID-generated by the merchant server to identify the transaction
*Enum:* `"ECI"`, `"XID"`
*Example:* `"ECI"` | No |
| Val | string | For ECI - Level of security used in an electronic commerce transaction. If none provided for eCom transactions, the default value of 7 is used in the request (1 Characters - 5/6/7/8). For XID - contains a unique Visa Secure Electronic Commerce (VSEC) number-the transaction ID or XID-generated by the merchant server to identify the transaction (40 Character Binary) | No |
#### tAddtlRskData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | CC: Condition Code
*Example:* `"CC"` | No |
| Val | string | Value for Tp
*Example:* `"10"` | No |
#### FuelBrndCd Schema
Fuel Brand
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FuelBrndCd | string | Fuel Brand | |
**Example**
CIRK
#### tVrfctnRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tVrfctnRes | [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", "CRYP", "NVSC", "OTHP", **"VrfctnRslt"**: { **"Tp"**: string, **"Rslt"**: string,
**Available values:** "SUCC", "NOVF", "FAIL", "ERRR", "MISS", **"RsltDtls"**: string } } ] | | |
**Example**
[
{
"Tp": "THDS",
"VrfctnRslt": {
"Tp": "authenticationValue",
"Rslt": "FAIL",
"RsltDtls": "0"
}
},
{
"Tp": "ADDB",
"VrfctnRslt": {
"Rslt": "SUCC",
"RsltDtls": "A"
}
},
{
"Tp": "PCDV",
"VrfctnRslt": {
"Rslt": "NOVF",
"RsltDtls": "R"
}
},
{
"Tp": "CSCV",
"VrfctnRslt": {
"Rslt": "SUCC",
"RsltDtls": "M"
}
},
{
"VrfctnRslt": {
"Tp": "DAF"
}
},
{
"VrfctnRslt": {
"Tp": "CRYP",
"Rslt": "SUCC"
}
},
{
"Tp": "OTHP",
"VrfctnRslt": {
"Tp": "AuthDataQualInd",
"RsltDtls": "1"
}
}
]
#### UnitOfMeasr Schema
Unit of Measure. LITR(Liter), USGA(U.S. gallon), GBGA(Imperial gallon), KILO(Kilo), PUND(Pound), CHMT(Charging minutes), KWHO(Kilowatt per hour)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| UnitOfMeasr | string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO" | Unit of Measure. LITR(Liter), USGA(U.S. gallon), GBGA(Imperial gallon), KILO(Kilo), PUND(Pound), CHMT(Charging minutes), KWHO(Kilowatt per hour) | |
**Example**
LITR
#### MaxAmt Schema
Maximum amount agreed to by the cardholder. Amount will be specified in F49 currency(Currency Code, Transaction)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MaxAmt | string | Maximum amount agreed to by the cardholder. Amount will be specified in F49 currency(Currency Code, Transaction) | |
**Example**
100.00
#### CardDataNtryMd Schema
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
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardDataNtryMd | string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" | 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 | |
**Example**
KEEN
#### AddtlCtctInf Schema
Contains acceptor additional contact information.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AddtlCtctInf | string | Contains acceptor additional contact information. | |
**Example**
4155551234
#### bSpclPrgrmmQlfctn Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Dtls | [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ] | *Example:* `[{"Nm":"BusTranTp","Val":"1"}]` | No |
| ApldSvc | string | Contains the indicate that the merchant has used a DCAP eligible method for authentication or data sharing and that they have provided all the mandatory DCAP data elements. 1 = VDCAP
*Example:* `"1"` | No |
#### MgntcStrpFllbckInd Schema
Magnetic Strip Fallback Indicator
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MgntcStrpFllbckInd | boolean | Magnetic Strip Fallback Indicator | |
**Example**
true
#### tTxCntxtRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CaptrDt | string | Capture Date in the format MMDD
*Example:* `"0421"` | No |
| AntcptdDt | string | Max settlement date for transaction. Date is in Julian date format, yddd
*Example:* `"4077"` | No |
| CardPrgrmm | { **"CardPrgrmmApld"**: { **"Id"**: string } } | | No |
| XchgRateInf | [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ] | | No |
| PINPadInprtv | boolean | Contains a PIN Pad indicator which is used to indicate whether or not the PIN pad is operative.
*Example:* `false` | No |
| MgntcStrpFllbckInd | boolean | Magnetic Strip Fallback Indicator
*Example:* `true` | No |
| MrchntCtgySpcfcData | string | Market-Specific Data Identifier
*Example:* `"B"` | No |
#### tRslt1 Schema
Transaction result.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tRslt1 | string,
**Available values:** "Approved", "PartiallyApproved", "NoReasonToDecline", "Declined", "Error" | Transaction result. | |
#### Fleet Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Summry | { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string } | | No |
| LineItm | [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] | 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. | No |
#### tCard Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PAN | string | Account number or token used in the transaction.
*Example:* `"4234567890123456"` | No |
| Trck1 | string | 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"` | No |
| Trck2 | { **"HexBinryVal"**: string } | | No |
| XpryDt | string | Expiration date of the account number or token in YYMM format.
*Example:* `"2212"` | No |
| SchmeId | string | Contains the card scheme selected for the transaction 01(Visa), 02(Others)
*Example:* `"01"` | No |
| CardSeqNb | string | A number assigned to a card when two or more individual cards are associated with the same primary account number
*Example:* `"0200"` | No |
#### MrchntCtgySpcfcData Schema
Market-Specific Data Identifier
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MrchntCtgySpcfcData | string | Market-Specific Data Identifier | |
**Example**
B
#### AuthntcnOutgInd Schema
SCA Outage Indicator
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AuthntcnOutgInd | boolean | SCA Outage Indicator | |
**Example**
true
#### AddtnlData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC" | 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"` | No |
| 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"` | No |
#### EvSpecific Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| EvSpecific | [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ] | | |
#### tSaleCntxt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GoodsAndSvcsTp | string,
**Available values:** "ELEC", "PHYS" | 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"` | No |
| GoodsAndSvcsSubTp | string,
**Available values:** "CRCU" | Possible Value - CRCU: Cryptocurrency purchase
*Enum:* `"CRCU"`
*Example:* `"CRCU"` | No |
#### Summry Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Drvr | { **"Id"**: string, **"MplyeeId"**: string } | | No |
| Vhcl | { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string } | | No |
| TripInf | { **"JobNb"**: string } | | No |
| TxRltdData | { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string } | | No |
| AgtFuelPrmptCd1 | string | Fleet Additional Prompted Data 1. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
*Example:* `"123456789kiikjhasjk1"` | No |
| AgtFuelPrmptCd2 | string | Fleet Additional Prompted Data 2. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
*Example:* `"123456789kiikjhasjk1"` | No |
#### AdrRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AdrLine1 | string | Contains merchant street address. | No |
#### RntlAgrmt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Drtn | string | For Rental it contains duration of rental in days
*Example:* `"1"` | No |
| CtctNm | string | Contains the name of renter.
*Example:* `"John Smith"` | No |
| VhclClss | string | Contains a code indicating the type of vehicle.
*Example:* `"01"` | No |
| DailyRate | string | Contains the daily rate being charged for the vehicle
*Example:* `"20.00"` | No |
| InsrncAmt | string | Contains insurance being charged for the vehicle.
*Example:* `"200.00"` | No |
| WeeklyRate | string | Contains the weekly rate being charged for the vehicle.
*Example:* `"14.00"` | No |
#### tAcctFrresp Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AcctId | string | Account Identification 1
*Example:* `"0000305071"` | No |
| AcctTp | string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" | Account Type from. Response values: SAVE - 10 Savings account, CHCK - 20 Checking account, CRDC - 30 Credit Card account, UNIV - 40 Universal, DRFD - 35 Deferred Debit, CHRG - 36 Charge, PRPD - 60 Prepaid, CEBT - 96 cash benefits account, FEBT - 98 Food stamps account.
*Enum:* `"CEBT"`, `"FEBT"`, `"SAVE"`, `"CHCK"`, `"CRDC"`, `"UNIV"`, `"DFRD"`, `"CHRG"`, `"PRPD"`
*Example:* `"CEBT"` | No |
#### tMessageIdentificationRsp Schema
Message identification and tracing elements.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | Visa assigned identifier for the client.
*Example:* `"0123456789012345678901234567893"` | No |
| reqstId | string | 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"` | No |
| correlatnId | string | correlatnId field must contain the same value as the original transaction being voided.
*Example:* `"12bc567d90f23e56a8f012"` | No |
#### tPtOfSvcCntxt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MOTOInd | boolean | Mail/Phone (MOTO) Boolean indicator distinguishing the type of mail or telephone order
*Example:* `true` | No |
| CardPres | boolean | Card Present
*Example:* `true` | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string } | | No |
| 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` | No |
| 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` | No |
| SpclConds | { **"Id"**: string } | | No |
| EComrcData | [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ] | *Example:* `[{"Tp":"ECI","Val":"5"},{"Tp":"XID","Val":"EEC4567F90123A5678B0123EA67890D2345678FF"}]` | No |
| CrdhldrPres | boolean | Card Holder Present
*Example:* `true` | No |
| 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` | No |
| CardDataNtryMd | string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" | 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"` | No |
| PrtlApprvlSpprtd | boolean | Indicates whether the terminal can support partially approved amounts. Set to true if partial authorization is supported and false if partial authorization is not supported
*Example:* `true` | No |
#### tRskAssmntRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Rslt | string | Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring. Or VAI Visa Account Attack Intelligence Score
*Example:* `"UnreliableICVV"` | No |
| RskAssmntTp | string,
**Available values:** "MSI", "VTA", "VAI" | Risk assessment type.
*Enum:* `"MSI"`, `"VTA"`, `"VAI"` | No |
#### Cpny Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Cd | string | A code that represents the travel agency used during booking, if applicable.
*Example:* `"12345678"` | No |
| Nm | string | The name of the travel agency used during booking, if applicable.
*Example:* `"Travel Agency"` | No |
#### tEnvt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Card | { **"PAN"**: string, **"Trck1"**: string, **"Trck2"**: { **"HexBinryVal"**: string }, **"XpryDt"**: string, **"SchmeId"**: string, **"CardSeqNb"**: string } | | No |
| Wllt | { **"Prvdr"**: { **"Id"**: string,
**Available values:** "VCIND" } } | | No |
| Accptr | { **"Id"**: string, **"Adr"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string, **"CtrySubDvsnMnr"**: string }, **"URL"**: string, **"PhneNb"**: string, **"ShrtNm"**: string, **"AddtlId"**: string, **"PrtnrId"**: string, **"SvcLctn"**: { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string }, **"AddtlIds"**: { **"Tp"**: string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP", **"Val"**: string }, **"CstmrSvc"**: string, **"PrvtData"**: { **"GtwyMrchntData"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"BizRegnId"**: string, **"LtdAccptnc"**: string, **"BizRegnIdTp"**: string,
**Available values:** "00", "01", "02", "03", "04", "99", **"FrgnRtlrInd"**: boolean, **"AddtlCtctInf"**: string, **"SpnsrdMrchnt"**: { **"Id"**: { **"Id"**: string } }, **"PaymentFacltId"**: string } | | No |
| Termnl | { **"Tp"**: string, **"SubTp"**: string, **"Cpblties"**: { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } }, **"TermnlId"**: { **"Id"**: string } } | | No |
| Crdhldr | { **"Id"**: { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } }, **"CrdhldrNm"**: { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string }, **"CrdhldrAge"**: { **"DtOfBirth"**: string }, **"CstmrDsgnt"**: string,
**Available values:** "Primary", "Secondary" } | | No |
#### tXmptnReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tXmptnReq | [ { **"Tp"**: string, **"Val"**: string } ] | | |
**Example**
[
{
"Tp": "TMBE",
"Val": "CLAI"
},
{
"Tp": "LOWA",
"Val": "CLAI"
}
]
#### tWllt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Prvdr | { **"Id"**: string,
**Available values:** "VCIND" } | | No |
#### VhclRntl Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RntlInvc | { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer } | | No |
| RntlAgrmt | { **"Drtn"**: string, **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } | | No |
#### tXmptnRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tXmptnRes | [ { **"Tp"**: string, **"Val"**: string, **"RsnNotHnrd"**: string } ] | | |
**Example**
[
{
"Tp": "LOWA",
"Val": "NHON"
},
{
"RsnNotHnrd": "8402"
},
{
"RsnNotHnrd": "8401"
},
{
"RsnNotHnrd": "8403"
},
{
"RsnNotHnrd": "8A02"
}
]
#### tRskAssmntReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Rslt | string | Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring
*Example:* `"UnreliableICVV"` | No |
| RskAssmntTp | string,
**Available values:** "MSI", "VTA" | Risk assessment type.
*Enum:* `"MSI"`, `"VTA"` | No |
#### Id Schema
Visa assigned identifier for the client.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | Visa assigned identifier for the client. | |
**Example**
0123456789012345678901234567893
#### RsltDtls Schema
Results of transaction request.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RsltDtls | string | Results of transaction request. | |
**Example**
00
#### PctAmtReq Schema
Percent of Amount Requested.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PctAmtReq | string | Percent of Amount Requested. | |
**Example**
13
#### PurchsTp Schema
Type of Purchase FUEL(Fuel purchase), NONF(Non-Fuel purchase), FANF(Fuel and Non-Fuel purchase)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PurchsTp | string,
**Available values:** "FUEL", "NONF", "FANF" | Type of Purchase FUEL(Fuel purchase), NONF(Non-Fuel purchase), FANF(Fuel and Non-Fuel purchase) | |
**Example**
FUEL
#### tXmptnArray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | 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"` | No |
| Val | string | Value associated with type of Strong Customer Authentication Type. Valid values in request: CLAI = Claimed
*Example:* `"CLAI"` | No |
#### TripLegarray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SeqNb | string,
**Available values:** "1", "2", "3", "4" | Trip leg sequence number
*Enum:* `"1"`, `"2"`, `"3"`, `"4"`
*Example:* `"1"` | No |
| Crrier | string | 2 character IATA airliner carrier code.
*Example:* `"DL"` | No |
| RouteNb | string | Contains the number of the airline flight to be taken on the each leg of the trip.
*Example:* `"12345"` | No |
| SvcClss | string | Service class code.
*Example:* `"Y"` | No |
| AddtlData | string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE" | 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"` | No |
| FareBsisCd | string | Contains a code that indicates the fare basis for the each leg of the trip
*Example:* `"E"` | No |
| StopOverInd | string,
**Available values:** "X", " ", "O" | Stop over indicator. space or O - Stop-over allowed, X No stop-over allowed
*Enum:* `"X"`, `" "`, `"O"`
*Example:* `"X"` | No |
#### MrchntCtgyCd Schema
4-digit Merchant Category Code (ISO 18245)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MrchntCtgyCd | integer | 4-digit Merchant Category Code (ISO 18245) | |
**Example**
4814
#### tcntxtVoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxCntxt | { **"CaptrDt"**: string, **"AntcptdDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"XchgRateInf"**: [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ], **"PINPadInprtv"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string } | | No |
| RskCntxt | { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", **"AddtlRskData"**: { **"Tp"**: string, **"Val"**: string } } ] } | | No |
| PtofSvcCntxt | { **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" } | | No |
#### TxDesc Schema
Information about the merchandise in the transaction.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxDesc | string | Information about the merchandise in the transaction. | |
**Example**
transactiondescription
#### SchmeId Schema
Contains the card scheme selected for the transaction 01(Visa), 02(Others)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SchmeId | string | Contains the card scheme selected for the transaction 01(Visa), 02(Others) | |
**Example**
01
#### ApprvlCd Schema
Authorization code from the issuer
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ApprvlCd | string | Authorization code from the issuer | |
**Example**
529801
#### AddtlData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn" | 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"` | No |
| Val | string | 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"` | No |
#### URL Schema
Contains acceptor URL address.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| URL | string | Contains acceptor URL address. | |
#### GrdTtlAmt Schema
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
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GrdTtlAmt | string | 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
#### ICCRltdData Schema
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).
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ICCRltdData | string | 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
#### RntlAgrmtvoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CtctNm | string | Contains the name of renter.
*Example:* `"John Smith"` | No |
| VhclClss | string | Contains a code indicating the type of vehicle.
*Example:* `"01"` | No |
| DailyRate | string | Contains the daily rate being charged for the vehicle
*Example:* `"20.00"` | No |
| InsrncAmt | string | Contains insurance being charged for the vehicle.
*Example:* `"200.00"` | No |
| WeeklyRate | string | Contains the weekly rate being charged for the vehicle.
*Example:* `"14.00"` | No |
#### TripInf Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| JobNb | string | Job Number
*Example:* `"123456789y"` | No |
#### ValInd Schema
Validation Indictor. Offline validation between Acquirer and Issuer during registration: false(not validated), true(validated)
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ValInd | string,
**Available values:** "true", "false" | Validation Indictor. Offline validation between Acquirer and Issuer during registration: false(not validated), true(validated) | |
**Example**
true
#### NtnlData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CountryCd | string | Contains a country code for jurisdictions participating in domestic processing.
*Example:* `"170"` | No |
| SpainData | [ { **"LclAccptrId"**: string, **"LclMrchntCtgyCd"**: string } ] | | No |
| AddtnlData | [ { **"Tp"**: string,
**Available values:** "NATTOKENDT", "NATIRF", "NATMATYP", "NATIRFBASE", "NATMISCAMT", "NATVATBASE", "NATCTAX", "NATVATAMT", "NATCTIND", "NATCBRC", **"Val"**: string } ] | | No |
#### tTermnlRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | This field containt code to identifies the basic POS electronic terminal type. 9 = MPOS (Use to identify that an mPOS device is used to originate a transaction on an open network)
*Example:* `"9"` | No |
| Cpblties | { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } } | | No |
| TermnlId | { **"Id"**: string } | | No |
#### aId Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| aId | string | 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
#### AddtlIdsTpVal Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "GtyMrchntData", "BusRegID", "MKTP", "GATW", "SDWT", "RMPP" | 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"` | No |
| Val | string | 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"` | No |
#### SplmtryDataRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SplmtryDataRes | [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string, **"RsnNotHnrd"**: string } ], **"DlgtdAuthrty"**: string } } ] | | |
#### AddtlId Schema
Unique identifier value assigned by Visa for each merchant included in the identification program
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AddtlId | string | Unique identifier value assigned by Visa for each merchant included in the identification program | |
**Example**
52014057
#### tRskCntxtRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RskAssmnt | [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", "VAI" } ] | | No |
#### RskAssmntRslt Schema
Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RskAssmntRslt | string | Result of risk assessment type (UnreliableICVV/UnreliableCVV). Or VTA ECommerce Scoring | |
**Example**
UnreliableICVV
#### CardPrgrmmApld Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | 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"` | No |
#### Plan Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Plan | [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ] | | |
#### SplmtryDataReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SplmtryDataReq | [ { **"StrngCstmrAuthntcn"**: { **"Xmptn"**: [ { **"Tp"**: string, **"Val"**: string } ], **"DlgtdAuthrty"**: string } } ] | | |
#### Cstmr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RefNb | string | 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"` | No |
| TxRegnId | string | Customer VAT Registration Number
*Example:* `"123456789adsq"` | No |
#### LineItmres Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LineItmres | [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] | 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. | |
#### GatewayAddtnlData Schema
Addtnldata for GatewayData. Contains Tp, Val pairs of data for non-Visa branded cards. Please reference the VPP release notes for a list of all Tp and Val pairs
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "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" | 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"` | No |
| 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"` | No |
#### AccAddtlDataTpVal Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | Sales Org Id
*Example:* `"ISOid"` | No |
| Val | string | Sales Org Id
*Example:* `"42999952606"` | No |
#### tAddtlCardDataArrayRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | Type of Additional Card Data. Possible Values - AcctFndgSrc -Account Funding Source.
*Example:* `"AcctFndgSrc"` | No |
| Val | string,
**Available values:** "CRDT", "DBIT", "PRPD" | Value associated with type of Account Funding Source. Possible Values - CRDT - Credit, DBIT - Debit, PRPD - Prepaid.
*Enum:* `"CRDT"`, `"DBIT"`, `"PRPD"`
*Example:* `"CRDT"` | No |
#### AdddmDatavoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Ldgg | { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] } | | No |
| Cstmr | { **"RefNb"**: string, **"TxRegnId"**: string } | | No |
| Fleet | { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] } | | No |
| Instlmt | { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string } | | No |
| RcrngPmt | { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" } | | No |
| TrvlAgcy | { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } } | | No |
| VhclRntl | { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } } | | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string } | | No |
| PurchsIdr | string | Identifies the purchase to the issuer and cardholder such as order number for card not present transactions
*Example:* `"0123-23"` | No |
| PurchsIdrTp | string,
**Available values:** "ORNU", "REAG", "FONU" | 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"` | No |
| PssngrTrnsprt | { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] } | | No |
| AddtlAccptrData | { **"TxRegnId"**: string } | | No |
#### tRskCntxtReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RskAssmnt | [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA" } ] | | No |
#### DtOfBirth Schema
Cardholder date of birth.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DtOfBirth | string | Cardholder date of birth. | |
**Example**
1960-10-10
#### tAmt1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Amt | string | Transaction amount with explicit decimal point to represent minor unit.
*Example:* `"123.45"` | No |
| Ccy | string | Numeric currency code conforming to ISO 4217.
*Example:* `"840"` | No |
#### AssoctdDataDstn Schema
TC 50 Destination Identifier
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AssoctdDataDstn | string | TC 50 Destination Identifier | |
**Example**
403456
#### Arrvl Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Dt | string | 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"` | No |
#### tVrfctn1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV" | 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"` | No |
| VrfctnInf | { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } | | No |
#### Planres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Planres | [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ] | | |
#### PSummry Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tckt | { **"ChngInd"**: string, **"RstrctdTcktInd"**: string } | | No |
| Pssngr | { **"Nm"**: string } | | No |
| ResSys | string | Contains a code that indicates the computerized reservation system used to make the reservation and purchase the ticket.
*Example:* `"DATS"` | No |
| Dprture | { **"Dt"**: string, **"Lctn"**: string } | | No |
| CdtRsnCd | string | Contains a code that indicates the reason for a credit to the cardholder.
*Example:* `"A"` | No |
#### TxSubTp Schema
Business Application Identifier - CB Consumer Bill Payment
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxSubTp | string | Business Application Identifier - CB Consumer Bill Payment | |
**Example**
CB
#### RegnRefNb Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RegnRefNb | string | 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
#### tTxAddtlDataTpVal Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "FreeFormDescData", "SharngGrpCd" | Free form description data for the transaction or Sharing Group Code
*Enum:* `"FreeFormDescData"`, `"SharngGrpCd"`
*Example:* `"FreeFormDescData"` | No |
| Val | string | 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"` | No |
#### SummryCmmdtyId Schema
Summary Commodity Code
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SummryCmmdtyId | string | Summary Commodity Code | |
**Example**
1234
#### tXchgRateInf Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tXchgRateInf | [ { **"Id"**: string, **"Prvdr"**: string, **"RateLck"**: { **"Elgbl"**: string }, **"XchgRateDtl"**: { **"Rate"**: string } } ] | | |
#### TripLeg Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TripLeg | [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] | | |
#### tRskCntxt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RskAssmnt | [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA", **"AddtlRskData"**: { **"Tp"**: string, **"Val"**: string } } ] | | No |
#### InstlmtPmtTp Schema
Installment Payment Type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| InstlmtPmtTp | string,
**Available values:** "0", "1", "2", "3" | Installment Payment Type | |
**Example**
1
#### LdggLineItmarray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP" | 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"` | No |
| Val | string | Contains amount, No decimal points should be used. Two decimal places are implied.
*Example:* `"1234"` | No |
| OthrTp | string,
**Available values:** "PRPD", "FDBV", "FCAA" | Contains prepaid expenses, food or beverage, folio cash advances being billed.
*Enum:* `"PRPD"`, `"FDBV"`, `"FCAA"`
*Example:* `"PRPD"` | No |
#### tTxAmts Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxAmt | { **"Amt"**: string, **"Ccy"**: string } | | No |
| AmtQlfr | string | 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"` | No |
| DtldAmt | [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] | *Example:* `[{"Tp":"SRCH","Amt":"100.00"},{"Tp":"CSHB","Amt":"200.00"}]` | No |
#### Tax Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tax | [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ] | | |
#### tPrcgRslt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RsltData | { **"Rslt"**: string,
**Available values:** "Approved", "PartiallyApproved", "NoReasonToDecline", "Declined", "Error", **"RsltDtls"**: string, **"AddtlRsltInf"**: [ { **"Tp"**: string, **"Val"**: string } ] } | | No |
| ApprvlData | { **"ApprvlCd"**: string } | | No |
#### BizRegnId Schema
Contains acceptor business registration ID.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BizRegnId | string | Contains acceptor business registration ID. | |
**Example**
123456789
#### RntlInvc Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ] | *Example:* `["FUEL","LATE"]` | No |
| TtlDrtn | string | Contains the total number of days that the vehicle was rented
*Example:* `"04"` | No |
| DpofChrg | string | Contains charges for one-way drop-off of the vehicle.
*Example:* `"123456789"` | No |
| FuelChrg | string | Contains fuel being charged for the vehicle.
*Example:* `"123456"` | No |
| ChckOutDt | string | 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"` | No |
| 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` | No |
#### PhneNb Schema
Contains acceptor phone number.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PhneNb | string | Contains acceptor phone number. | |
**Example**
4155551234
#### FleetPdctCd Schema
Fuel or non-fuel product code. Fuel type codes are listed in Base II Clearing Data Codes document.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FleetPdctCd | string | Fuel or non-fuel product code. Fuel type codes are listed in Base II Clearing Data Codes document. | |
**Example**
1A
#### TtlInsrnc Schema
Total Insurance
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlInsrnc | string | Total Insurance | |
**Example**
10.00
#### PssngrTrnsprt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Summry | { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string } | | No |
| TripLeg | [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] | | No |
#### PrtctdData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NcrptdData | { **"Algo"**: string,
**Available values:** "TDEA", "AES", **"Ctrl"**: string,
**Available values:** "DUKPT", "ZCK", **"DrvdInf"**: string, **"KeyIndx"**: string, **"KeySetIdr"**: string, **"PINBlckFrmt"**: string, **"NcrptdPINBlck"**: string } | | No |
#### AdddmData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Ldgg | { **"Summry"**: { **"Drtn"**: string, **"Arrvl"**: { **"Dt"**: string }, **"RoomRt"**: string, **"TtlTax"**: string, **"RoomNite"**: string, **"NoShowInd"**: integer, **"TtlRoomTax"**: string }, **"LdggLineItm"**: [ { **"Tp"**: string,
**Available values:** "REST", "GIFT", "MINI", "PHON", "OTHR", "LAUN", "OTHP", **"Val"**: string, **"OthrTp"**: string,
**Available values:** "PRPD", "FDBV", "FCAA" } ] } | | No |
| Cstmr | { **"RefNb"**: string, **"TxRegnId"**: string } | | No |
| Fleet | { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"EvChargInd"**: string,
**Available values:** "true", "false", **"EvSpecific"**: [ { **"Tp"**: string,
**Available values:** "TtlTm", "TtlChrgTm", "StrtTm", "EndTm", "PwrCpcty", "ChrgRsnCode", "EstmAdd", "CrbnFtprnt", "EstmAvlb", "MaxPwrDspnsd", "ConnTp", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] } | | No |
| Instlmt | { **"Plan"**: [ { **"TtlTax"**: string, **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"TtlFees"**: string, **"GracePrd"**: string, **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"FrstPmtDt"**: string, **"GrdTtlAmt"**: string, **"PctAmtReq"**: string, **"PctTtlTax"**: string, **"SbsqntAmt"**: string, **"TtlExpnss"**: string, **"TtlInsrnc"**: string, **"InstlmtCcy"**: string, **"PctTtlFees"**: string, **"TtlAmtFund"**: string, **"TtlNbOfPmts"**: string, **"TtlOthrCost"**: string, **"InstlmtPmtTp"**: string,
**Available values:** "0", "1", "2", "3", **"PctTtlExpnss"**: string, **"PctTtlInsrnc"**: string, **"InstlmtIntrst"**: string, **"AnnlIntrstRate"**: string, **"AnnlTtlCostFin"**: string, **"MnthIntrstRate"**: string, **"PctTtlOtherCost"**: string, **"VATInstlmtIntrst"**: string } ], **"PmtSeqNb"**: string } | | No |
| RcrngPmt | { **"Tp"**: string,
**Available values:** "1", "2", "3", "4", **"Frqcy"**: string,
**Available values:** "DAIL", "TWWK", "WEEK", "TEND", "FRTN", "MNTH", "BIMN", "TMTR", "QURT", "MIAN", "YEAR", "ADHO", **"MaxAmt"**: string, **"ValInd"**: string,
**Available values:** "true", "false", **"NbOfPmt"**: string, **"RegnRefNb"**: string, **"PerTxAmtTp"**: string,
**Available values:** "1", "2" } | | No |
| TrvlAgcy | { **"Cpny"**: { **"Cd"**: string, **"Nm"**: string } } | | No |
| VhclRntl | { **"RntlInvc"**: { **"Tp"**: [ { **"Tp"**: string,
**Available values:** "FUEL", "EXDI", "LATE", "ONEW", "FINE" } ], **"TtlDrtn"**: string, **"DpofChrg"**: string, **"FuelChrg"**: string, **"ChckOutDt"**: string, **"NoShowInd"**: integer }, **"RntlAgrmt"**: { **"Drtn"**: string, **"CtctNm"**: string, **"VhclClss"**: string, **"DailyRate"**: string, **"InsrncAmt"**: string, **"WeeklyRate"**: string } } | | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string } | | No |
| PurchsIdr | string | Identifies the purchase to the issuer and cardholder such as order number for card not present transactions
*Example:* `"0123-23"` | No |
| PurchsIdrTp | string,
**Available values:** "ORNU", "REAG", "FONU" | 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"` | No |
| PssngrTrnsprt | { **"Summry"**: { **"Tckt"**: { **"ChngInd"**: string, **"RstrctdTcktInd"**: string }, **"Pssngr"**: { **"Nm"**: string }, **"ResSys"**: string, **"Dprture"**: { **"Dt"**: string, **"Lctn"**: string }, **"CdtRsnCd"**: string }, **"TripLeg"**: [ { **"SeqNb"**: string,
**Available values:** "1", "2", "3", "4", **"Crrier"**: string, **"RouteNb"**: string, **"SvcClss"**: string, **"AddtlData"**: string,
**Available values:** "XUP", "XAF", "XCA", "XOT", "XDF", "XAE", "XAO", "XAA", "XTD", "XPC", "XPE", **"FareBsisCd"**: string, **"StopOverInd"**: string,
**Available values:** "X", " ", "O" } ] } | | No |
| AddtlAccptrData | { **"TxRegnId"**: string } | | No |
#### CardPdctTp Schema
Contains a product ID.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardPdctTp | string | Contains a product ID. | |
**Example**
G1
#### tempdef51 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TxId | { **"CardIssrRefData"**: string } | | No |
| AcctFr | { **"AcctId"**: string, **"AcctTp"**: string,
**Available values:** "CEBT", "FEBT", "SAVE", "CHCK", "CRDC", "UNIV", "DFRD", "CHRG", "PRPD" } | | No |
| TxAmts | { **"TxAmt"**: { **"Amt"**: string, **"Ccy"**: string }, **"AmtQlfr"**: string, **"DtldAmt"**: [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] } | | No |
| TxSubTp | string | Business Application Identifier - CB Consumer Bill Payment
*Example:* `"CB"` | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "FreeFormDescData", "SharngGrpCd", **"Val"**: string } | | No |
| SpclPrgrmmQlfctn | { **"Dtls"**: [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ], **"ApldSvc"**: string } | | No |
#### CardRdngCpblty Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardRdngCpblty | string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY" | 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. | |
**Example**
MGST
#### PmtSeqNb Schema
Payment Sequence Number
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PmtSeqNb | string | Payment Sequence Number | |
**Example**
20
#### NcrptdData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Algo | string,
**Available values:** "TDEA", "AES" | Contains an encryption algorithm used to encipher encrypted data elements in dataset or keys in associated key management data element. TDEA = TDES, AES = AES
*Enum:* `"TDEA"`, `"AES"`
*Example:* `"TDEA"` | No |
| Ctrl | string,
**Available values:** "DUKPT", "ZCK" | Key Management scheme for encryption data in dataset.
*Enum:* `"DUKPT"`, `"ZCK"`
*Example:* `"DUKPT"` | No |
| DrvdInf | string | Contains 19-bit device ID and 21-bit transaction counter. Required for PIN data with DUKPT encryption.
*Example:* `"0002100001"` | No |
| KeyIndx | string | Identifies zone key index
*Example:* `"01"` | No |
| KeySetIdr | string | Specifies identifier for encryption key. Required for PIN data with DUKPT encryption.
*Example:* `"4B001F00"` | No |
| PINBlckFrmt | string | Carries code defining encrypted PIN data format and describing PIN block format.
*Example:* `"01"` | No |
| NcrptdPINBlck | string | Encrypted Pin Data. Required for PIN data with AWK, IWK, and DUKPT encryption. 16 Characters for TDES Keys, 32 Characters for AES Keys
*Example:* `"357E11711A2D4430"` | No |
#### tAcceptorId Schema
Payment Facilitator Identifier Identifies the marketplace or payment facilitator
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tAcceptorId | string | Payment Facilitator Identifier Identifies the marketplace or payment facilitator | |
**Example**
52014057
#### tempdef0 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| msg | string | Message providing more details about the error
*Example:* `"Invalid Primary Account"` | No |
| code | string | Code that can be used to contact Visa about a specific error.
*Example:* `"2"` | No |
#### Amt Schema
Transaction amount with explicit decimal point to represent minor unit.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Amt | string | Transaction amount with explicit decimal point to represent minor unit. | |
**Example**
123.45
#### PlanOwnr Schema
Installment plan owner. ISSR = 01, ACCP = 03
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PlanOwnr | string,
**Available values:** "ISSR", "ACCP" | Installment plan owner. ISSR = 01, ACCP = 03 | |
**Example**
ISSR
#### tAdr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Ctry | string | The 2-character, uppercase alpha code for the country where the customer transaction occurs
*Example:* `"US"` | No |
| TwnNm | string | 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. | No |
| PstlCd | string | 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"` | No |
| AdrLine1 | string | Contains merchant street address. | No |
| CtrySubDvsnMjr | string | 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"` | No |
| CtrySubDvsnMnr | string | 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"` | No |
#### GatewayBrand Schema
Contains a Brand for GatewayData processing. Valid values: Mastercard - MSC, American Express - AMX, Discover - DSC
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GatewayBrand | string,
**Available values:** "MSC", "AMX", "DSC" | Contains a Brand for GatewayData processing. Valid values: Mastercard - MSC, American Express - AMX, Discover - DSC | |
**Example**
MSC
#### tTaxRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "VATA" | VATA(VAT Tax rate)
*Enum:* `"VATA"`
*Example:* `"VATA"` | No |
| Dcmnttn | string | VAT Documentation Indicator
*Example:* `"11"` | No |
#### AddtlSvc Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "DCCV", "OTHP" | Dynamic Currency Conversion Indicator or Other value
*Enum:* `"DCCV"`, `"OTHP"`
*Example:* `"OTHP"` | No |
| Dtl | { **"AgeVrfctnReqData"**: string } | | No |
| Val | string | Additional service value. | No |
| OthrTp | string,
**Available values:** "StoreTxId", "RetrieveTxId", "StoreRetrieveTxId" | Transaction ID Service Instruction. StoreTxId – Store transaction ID ,RetrieveTxId – Retrieve transaction ID ,StoreRetrieveTxId – Save/Retrieve
*Enum:* `"StoreTxId"`, `"RetrieveTxId"`, `"StoreRetrieveTxId"`
*Example:* `"StoreTxId"` | No |
#### reqstId Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reqstId | string | 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
#### tTermnlvoid Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | 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"` | No |
| SubTp | string | Account Entry Device Type | No |
| Cpblties | { **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } } | | No |
#### SpainData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LclAccptrId | string | Contains Spanish merchant ID when it differs from the international merchant ID. | No |
| LclMrchntCtgyCd | string | Contains the domestic MCC when it differs from the international MCC
*Example:* `"6010"` | No |
#### Trck2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| HexBinryVal | string | the information encoded on Track 2 of the magnetic stripe, including field separators but excluding beginning and ending sentinels and LRC characters
*Example:* `"04000220130005421D230620100222222222"` | No |
#### DtldAmt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DtldAmt | [ { **"Tp"**: string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q", **"Amt"**: string, **"CdtDbt"**: string,
**Available values:** "CRDT", "DBIT" } ] | | |
**Example**
[
{
"Tp": "SRCH",
"Amt": "100.00"
},
{
"Tp": "CSHB",
"Amt": "200.00"
}
]
#### Crdhldr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | { **"IdCd"**: string, **"IdVal"**: string, **"IdSubCd"**: string, **"AssgnrAuthrty"**: { **"Ctry"**: string } } | | No |
| CrdhldrNm | { **"GvnNm"**: string, **"LastNm"**: string, **"MddlNm"**: string } | | No |
| CrdhldrAge | { **"DtOfBirth"**: string } | | No |
| CstmrDsgnt | string,
**Available values:** "Primary", "Secondary" | Account Owner Type. Primary - 01, Secondary - 02
*Enum:* `"Primary"`, `"Secondary"`
*Example:* `"Primary"` | No |
#### tempdef56 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| authVoid | { **"href"**: object } | | No |
| authCapture | { **"href"**: object } | | No |
#### Trck1 Schema
the information encoded on Track 1 of the magnetic stripe, including field separators but excluding beginning and ending sentinels and LRC characters
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Trck1 | string | 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
#### tTaxReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "LOCL", "VATA" | Type of tax included in this purchase. LOCL(Local Tax), VATA(VAT Tax rate)
*Enum:* `"LOCL"`, `"VATA"`
*Example:* `"VATA"` | No |
| Amt | string | Tax Amount. Two decimal places are implied. Only applicable to “Tp” value “LOCL”
*Example:* `"100.00"` | No |
| Dcmnttn | string | VAT Documentation Indicator. Only applicable to “Tp” value “VATA”
*Example:* `"1 "` | No |
#### MnthIntrstRate Schema
Monthly Interest Rates
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MnthIntrstRate | string | Monthly Interest Rates | |
**Example**
6
#### tempdef83 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PltfrmCd | string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT" | 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"` | No |
| CardSeqNb | string | A number assigned to a card when two or more individual cards are associated with the same primary account number
*Example:* `"0200"` | No |
| PmtAccRef | string | 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"` | No |
| CardPdctTp | string | Contains a product ID.
*Example:* `"G1"` | No |
| CardPrtflIdr | string | Contains a program identification number used with a product ID attribute
*Example:* `"ABCD12"` | No |
| AddtlCardData | [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ] | *Example:* `[{"Tp":"AcctFndgSrc","Val":"CRDT"}]` | No |
| ReplacementPAN | string | Replacement PAN if new PAN requested / Replacement account number provided by Real Time VAU
*Example:* `"4234567890123456"` | No |
| PANFourLastDgts | string | Last 4 digits of the account number.
*Example:* `"3456"` | No |
#### resAccptr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | 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"` | No |
| Adr | { **"AdrLine1"**: string } | | No |
| URL | string | Contains acceptor URL address. | No |
| PhneNb | string | Contains acceptor phone number.
*Example:* `"4155551234"` | No |
| PrtnrId | string | Contains acceptor partner ID code. | No |
| SvcLctn | { **"Ctry"**: string, **"TwnNm"**: string, **"PstlCd"**: string, **"AdrLine1"**: string, **"CtrySubDvsnMjr"**: string } | | No |
| CEDPVrfd | string | Merchant CEDP Verified Indicator
*Example:* `"Y"` | No |
| CstmrSvc | string | 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"` | No |
| BizRegnId | string | Contains acceptor business registration ID.
*Example:* `"123456789"` | No |
| BizRegnIdTp | string,
**Available values:** "00", "01", "02", "03", "04", "99" | 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"` | No |
| AddtlCtctInf | string | Contains acceptor additional contact information.
*Example:* `"4155551234"` | No |
#### tCntxt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Vrfctn | [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ] | *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"}}}]` | No |
| TxCntxt | { **"CaptrDt"**: string, **"CardPrgrmm"**: { **"CardPrgrmmApld"**: { **"Id"**: string } }, **"ICCFllbckInd"**: string, **"MrchntCtgyCd"**: integer, **"MrchntVolInd"**: string, **"PINPadInprtv"**: boolean, **"AuthntcnOutgInd"**: boolean, **"MgntcStrpFllbckInd"**: boolean, **"MrchntCtgySpcfcData"**: string } | | No |
| RskCntxt | { **"RskAssmnt"**: [ { **"Rslt"**: string, **"RskAssmntTp"**: string,
**Available values:** "MSI", "VTA" } ] } | | No |
| SaleCntxt | { **"GoodsAndSvcsTp"**: string,
**Available values:** "ELEC", "PHYS", **"GoodsAndSvcsSubTp"**: string,
**Available values:** "CRCU" } | | No |
| PtOfSvcCntxt | { **"MOTOInd"**: boolean, **"CardPres"**: boolean, **"AddtlData"**: { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string }, **"AttnddInd"**: boolean, **"EComrcInd"**: boolean, **"SpclConds"**: { **"Id"**: string }, **"EComrcData"**: [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ], **"CrdhldrPres"**: boolean, **"CrdhldrActvtd"**: boolean, **"CardDataNtryMd"**: string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL", **"PrtlApprvlSpprtd"**: boolean } | | No |
#### Instlmtres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Plan | [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ] | | No |
| PmtSeqNb | string | Payment Sequence Number
*Example:* `"20"` | No |
#### tSpclPrgrmmQlfctnPgm Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| IMP | string | Installment Merchant Program Qualification indicator
*Example:* `"Y"` | No |
| Dtls | [ { **"Nm"**: string,
**Available values:** "ACI", "ValCode", "MVV", "SPEND", "BusTranTp", "USREG", "DwngdRsnCd", "EVV", **"Val"**: string } ] | *Example:* `[{"Nm":"BusTranTp","Val":"1"}]` | No |
| Prgrmm | string | Specifies the name of the special incentive program. Only Valid Value is CPS (Custom Payment Service)
*Example:* `"CPS"` | No |
| ApldSvc | string | Contains the indicate that the merchant has used a DCAP eligible method for authentication or data sharing and that they have provided all the mandatory DCAP data elements. 1 = VDCAP
*Example:* `"1"` | No |
#### PltfrmCd Schema
Applied Product Platform Code indicates the card product platform. Possible Values - Business - BUSS, Consumer - CSMR, Commercial - COMM, Government - GOVN, Payouts - PYOT.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PltfrmCd | string,
**Available values:** "BUSS", "CSMR", "COMM", "GOVN", "PYOT" | Applied Product Platform Code indicates the card product platform. Possible Values - Business - BUSS, Consumer - CSMR, Commercial - COMM, Government - GOVN, Payouts - PYOT. | |
**Example**
BUSS
#### AddtlCardData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AddtlCardData | [ { **"Tp"**: string, **"Val"**: string,
**Available values:** "CRDT", "DBIT", "PRPD" } ] | | |
**Example**
[
{
"Tp": "AcctFndgSrc",
"Val": "CRDT"
}
]
#### Drvr Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | Driver Identification
*Example:* `"123456789adhjbnhyui1"` | No |
| MplyeeId | string | Fleet Employee Number. Contains the Visa Fleet cardholder employee number.
*Example:* `"1234r4r4r456"` | No |
#### EFleetPdctCd Schema
Expanded non-fuel type. Contains the purchased expanded non-fuel product code
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| EFleetPdctCd | string | Expanded non-fuel type. Contains the purchased expanded non-fuel product code | |
**Example**
1A01
#### InstlmtIntrst Schema
Installment Payment Interest
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| InstlmtIntrst | string | Installment Payment Interest | |
**Example**
0.13
#### tVrfctn Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tVrfctn | [ { **"Tp"**: string,
**Available values:** "THDS", "ADDB", "PCDV", "CSCV", **"VrfctnInf"**: { **"Tp"**: string, **"Rsn"**: string,
**Available values:** "Illegible", "NotAttempted", "NotOnCard", **"Val"**: { **"TxtVal"**: string, **"PINData"**: { **"Algo"**: string, **"KeyIndx"**: string, **"PINBlckFrmt"**: string }, **"HexBinryVal"**: string } } } ] | | |
**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"
}
}
}
]
#### DtldAmtArray Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string,
**Available values:** "SRCH", "CSHB", "4S", "4V", "4U", "4W", "4X", "3S", "4P", "4Q" | 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"` | No |
| Amt | string | Additional transaction detail type amount for either surcharge or cashback
*Example:* `"100.00"` | No |
| CdtDbt | string,
**Available values:** "CRDT", "DBIT" | 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"` | No |
#### RskAssmntTpRes Schema
Risk assessment type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RskAssmntTpRes | string,
**Available values:** "MSI", "VTA", "VAI" | Risk assessment type. | |
#### tTermnl Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | 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"` | No |
| SubTp | string | Account Entry Device Type | No |
| Cpblties | { **"CardRdngCpblty"**: string,
**Available values:** "MGST", "KEEN", "OPTC", "OCRR", "ICCY", "ICPY", **"PINLngthCpblties"**: string, **"CrdhldrVrfctnCpblty"**: { **"Cpblty"**: string,
**Available values:** "UNSP", "NPIN", "NOOP" } } | | No |
| TermnlId | { **"Id"**: string } | | No |
#### MOTOInd Schema
Mail/Phone (MOTO) Boolean indicator distinguishing the type of mail or telephone order
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MOTOInd | boolean | Mail/Phone (MOTO) Boolean indicator distinguishing the type of mail or telephone order | |
**Example**
true
#### SbsqntAmt Schema
Approximate Amount of each Installment
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| SbsqntAmt | string | Approximate Amount of each Installment | |
**Example**
6500.00
#### TtlTax Schema
Total Taxes
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlTax | string | Total Taxes | |
**Example**
10.00
#### aTwnNm Schema
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.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| aTwnNm | string | 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. | |
#### CardPrtflIdr Schema
Contains a program identification number used with a product ID attribute
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardPrtflIdr | string | Contains a program identification number used with a product ID attribute | |
**Example**
ABCD12
#### TtlOthrCost Schema
Total Other Costs
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| TtlOthrCost | string | Total Other Costs | |
**Example**
8.00
#### tTxId Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| 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"` | No |
#### CaptureDt Schema
Capture Date in the format MMDD
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CaptureDt | string | Capture Date in the format MMDD | |
**Example**
0421
#### RskAssmntTp Schema
Risk assessment type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RskAssmntTp | string,
**Available values:** "MSI", "VTA" | Risk assessment type. | |
#### tXmptnArrayRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | 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"` | No |
| Val | string | Value associated with type of Strong Customer Authentication Type. Valid values in response: HONO = Honored, NHON = Not Honored
*Example:* `"HONO"` | No |
| RsnNotHnrd | string | This tag (up to 20) is used to input text to detail a reason the exemption was not honored. This will be present in the Response. Multiple response tags can be present for a single exemption request
*Example:* `"8401"` | No |
#### AltrnMsgRsn Schema
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).
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AltrnMsgRsn | string | 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
#### tVrfctnRslt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | Tp value for verification. Possible value is authenticationValue (Card Authentication Verification Value) if Tp=THDS. DAF - Digital Authentication Framework, AuthDataQualInd if Tp=OTHP
*Example:* `"authenticationValue"` | No |
| Rslt | string,
**Available values:** "SUCC", "NOVF", "FAIL", "ERRR", "MISS" | Verification result. SUCC - Success, NOVF - Unable to verify, FAIL - Failure, ERRR - Error in verifying, MISS - Missing required value
*Enum:* `"SUCC"`, `"NOVF"`, `"FAIL"`, `"ERRR"`, `"MISS"` | No |
| RsltDtls | string | Results of transaction request. M - CVV2/dCVV2 provided and matched, N - CVV2/dCVV2 provided and did not match, S - Required CVV2/dCVV2 information not provided, P - CVV2/dCVV2 not performed, U - Unable to Verify
*Example:* `"00"` | No |
#### AgtFuelPrmptCd2 Schema
Fleet Additional Prompted Data 2. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgtFuelPrmptCd2 | string | Fleet Additional Prompted Data 2. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes. | |
**Example**
123456789kiikjhasjk1
#### tStrngCstmrAuthntcnReq Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Xmptn | [ { **"Tp"**: string, **"Val"**: string } ] | *Example:* `[{"Tp":"TMBE","Val":"CLAI"},{"Tp":"LOWA","Val":"CLAI"}]` | No |
| DlgtdAuthrty | string | Details regarding Delegated Authority - CLAI = Claimed
*Example:* `"CLAI"` | No |
#### AgtFuelPrmptCd1 Schema
Fleet Additional Prompted Data 1. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AgtFuelPrmptCd1 | string | Fleet Additional Prompted Data 1. Contains information the cardholder is prompted to provide at the POS for issuer and fleet employer purposes. | |
**Example**
123456789kiikjhasjk1
#### AdddmDatavoidres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Cstmr | { **"RefNb"**: string, **"TxRegnId"**: string } | | No |
| Fleet | { **"Summry"**: { **"Drvr"**: { **"Id"**: string, **"MplyeeId"**: string }, **"Vhcl"**: { **"Odmtr"**: string, **"TrlrNb"**: string, **"FleetNb"**: string, **"VhclIdNb"**: string }, **"TripInf"**: { **"JobNb"**: string }, **"AddtlData"**: { **"Tp"**: string, **"Val"**: string }, **"TxRltdData"**: { **"Tax"**: [ { **"Tp"**: string,
**Available values:** "LOCL", "NATI", "VATA", "OTHR", **"Amt"**: string, **"Rate"**: string, **"InclInTtlInd"**: string,
**Available values:** "true", "false" } ], **"TaxTtl"**: { **"TaxXmptn"**: boolean }, **"PurchsTp"**: string,
**Available values:** "FUEL", "NONF", "FANF", **"SummryCmmdtyId"**: string }, **"AgtFuelPrmptCd1"**: string, **"AgtFuelPrmptCd2"**: string }, **"LineItm"**: [ { **"SvcTp"**: string,
**Available values:** "FLSV", "SLSV", **"FuelInd"**: string,
**Available values:** "true", "false", **"PdctQty"**: string, **"UnitCost"**: [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ], **"FuelBrndCd"**: string, **"FleetPdctCd"**: string, **"UnitOfMeasr"**: string,
**Available values:** "LITR", "USGA", "GBGA", "KILO", "PUND", "CHMT", "KWHO", **"EFleetPdctCd"**: string } ] } | | No |
| Instlmt | { **"Plan"**: [ { **"PrdUnit"**: string,
**Available values:** "YEAR", "MNTH", "QURT", "WEEK", "MIAN", **"NbOfPrds"**: string,
**Available values:** "1", "2", "4", ".5", **"PlanOwnr"**: string,
**Available values:** "ISSR", "ACCP", **"GrdTtlAmt"**: string, **"SbsqntAmt"**: string, **"InstlmtCcy"**: string, **"TtlNbOfPmts"**: string } ], **"PmtSeqNb"**: string } | | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PlanRegSysId", "HostBsdPrchRstrctn", **"Val"**: string } | | No |
| AddtlAccptrData | { **"TxRegnId"**: string } | | No |
#### TxIdres Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardIssrRefData | string | Gateway Transaction ID
*Example:* `"1234567"` | No |
#### PtOfSvcCntxt Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardPres | boolean | Card Present
*Example:* `true` | No |
| AddtlData | { **"Tp"**: string,
**Available values:** "PrchRstrctnInd", **"Val"**: string } | | No |
| 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` | No |
| 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` | No |
| EComrcData | [ { **"Tp"**: string,
**Available values:** "ECI", "XID", **"Val"**: string } ] | *Example:* `[{"Tp":"ECI","Val":"5"},{"Tp":"XID","Val":"EEC4567F90123A5678B0123EA67890D2345678FF"}]` | No |
| CrdhldrPres | boolean | Card Holder Present
*Example:* `true` | No |
| 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` | No |
| CardDataNtryMd | string,
**Available values:** "UNSP", "KEEN", "MGST", "OPTC", "ICCY", "ICPY", "MSIP", "CDFL" | 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"` | No |
#### tStrngCstmrAuthntcnRes Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Xmptn | [ { **"Tp"**: string, **"Val"**: string, **"RsnNotHnrd"**: string } ] | *Example:* `[{"Tp":"LOWA","Val":"NHON"},{"RsnNotHnrd":"8402"},{"RsnNotHnrd":"8401"},{"RsnNotHnrd":"8403"},{"RsnNotHnrd":"8A02"}]` | No |
| DlgtdAuthrty | string | Details regarding Delegated Authority - HONO = Honored, NHON = Not Honored
*Example:* `"HONO"` | No |
#### PctTtlInsrnc Schema
Percent of Total Insurance
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PctTtlInsrnc | string | Percent of Total Insurance | |
**Example**
4
#### tMessageIdentificationRsp1 Schema
Message identification and tracing elements.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | Visa assigned identifier for the client.
*Example:* `"0123456789012345678901234567893"` | No |
| reqstId | string | 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"` | No |
| correlatnId | string | correlatnId field must contain the same value as the original transaction being voided.
*Example:* `"12bc567d90f23e56a8f012"` | No |
#### tFrgnRtlrInd Schema
Identifies a foreign retailer under a marketplace. DEfault value is false
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tFrgnRtlrInd | boolean | Identifies a foreign retailer under a marketplace. DEfault value is false | |
**Example**
false
#### UnitCost Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| UnitCost | [ { **"Tp"**: string,
**Available values:** "UNPC", "GRFP", "NTFP", "GNFP", "NFFP", **"Val"**: string } ] | | |
#### VATInstlmtIntrst Schema
VAT for Installment Payment Interest. Vat calculated by acquirer for interest applicable to the transaction.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| VATInstlmtIntrst | string | VAT for Installment Payment Interest. Vat calculated by acquirer for interest applicable to the transaction. | |
**Example**
5.13
#### PctTtlTax Schema
Percent of Total taxes
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PctTtlTax | string | Percent of Total taxes | |
**Example**
4
#### Ccy Schema
Numeric currency code conforming to ISO 4217.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Ccy | string | Numeric currency code conforming to ISO 4217. | |
**Example**
840
#### tTracData Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Tp | string | Data that is returned unaltered in the response message.
*Example:* `"AddtnlTraceData"` | No |
| Val | string | Data that is returned unaltered in the response message.
*Example:* `"anyroundtripinfo"` | No |
#### tAmtQlfr Schema
Qualifier or type of amount. Possible value is ESTM (Estimated amount) (the final amount could be more or less than the estimated amount
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| tAmtQlfr | string | 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
#### tXchgRateInfItem Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Id | string | Exchange Rate Identification. Identification of the specific rate, table, or file that contains the rate information.
*Example:* `"A0003"` | No |
| Prvdr | string | Identifies the source of exchange rate information. Valid value is 'Visa Inc., Exchange Rate'
*Example:* `"Visa Inc., Exchange Rate"` | No |
| RateLck | { **"Elgbl"**: string } | | No |
| XchgRateDtl | { **"Rate"**: string } | | No |