General Message Layout
This section provides the list of elements supported in each message type. All of these XML tags are defined in nexo Acquirer v6 protocol (CAPE ACQ MDR and CAPE ACQ MUG). The description provided below should be used in conjunction with the nexo description of each tag.
The column 'Presence' shows 'm' for mandatory fields or 'o' for optional fields indicating if this tag is relevant for the processing. For more details consult NEXO XSD and NEXO Message Definition Report. In some rare cases you may find discrepancies about the presence of some fields.
Common elements
| # Tag | Description | Presence |
|---|---|---|
Hdr/PrtcolVrsn | Use '6.0'. Will be copied into response | m |
Hdr/XchgId | Id for this message defined by terminal vendor. Will be copied into response. | m |
Hdr/CreDtTm | When message was sent (in ISODateTime). Will be copied into response. | m |
Hdr/InitgPty/Id | Identifies sender (name of host or application). Will be copied into response. | m |
Hdr/InitgPty/Tp | Ignored. | o |
Hdr/InitgPty/Issr | Ignored. | o |
Hdr/InitgPty/Ctry | Ignored. | o |
Hdr/InitgPty/ShrtNm | Ignored. | o |
Hdr/RcptPty/Id | Identifies recipient. Use 'IPG' | o |
Hdr/RcptPty/Tp | Ignored. | o |
Hdr/RcptPty/Issr | Ignored. | o |
Hdr/RcptPty/Ctry | Ignored. | o |
Hdr/RcptPty/ShrtNm | Ignored. | o |
Hdr/RcptPty/RmotAccs | Ignored. | o |
Hdr/RcptPty/RmotAccs/Adr | Ignored. | o |
Hdr/RcptPty/RmotAccs/Adr/NtwkTp | Ignored. | o |
Hdr/RcptPty/RmotAccs/Adr/AdrVal | Ignored. | o |
Hdr/RcptPty/RmotAccs/UsrNm | Ignored. | o |
Hdr/RcptPty/RmotAccs/AccsCd | Only used for BLIK, see: link | o |
Hdr/RcptPty/RmotAccs/SvrCert | Ignored. | |
Hdr/RcptPty/RmotAccs/SvrCertIdr | Ignored. | |
Hdr/RcptPty/RmotAccs/ClntCert | Ignored. | |
Hdr/RcptPty/RmotAccs/SctyPrfl | Ignored. | |
Hdr/Tracblt/... | see 'Possible use cases of Traceability element' | |
Envt/Acqrr/Id/Id | Id of the acquirer. Will be copied into response. For testing use '00001'. Note available for 'AccptrCcyConvsReq' | o |
Envt/Acqrr/Id/Tp | Ignored. | o |
Envt/Acqrr/Id/Issr | Ignored. | o |
Envt/Acqrr/Id/Ctry | Ignored. | o |
Envt/Acqrr/Id/ShrtNm | Ignored. | o |
Envt/Acqrr/ParamsVrsn | Use version of parameters loaded into terminal or date when parameters were loaded into terminal. Will be copied into response. | m |
Envt/Mrchnt/Id/Id | Card-brand specific Merchant ID. Needs to be populated by terminal with the same information as in EMV tag 9F16. | m (1) (2) |
Envt/Mrchnt/Id/Tp | Ignored. | o (1) (2) |
Envt/Mrchnt/Id/Issr | Ignored. | o (1) (2) |
Envt/Mrchnt/Id/ShrtNm | Ignored. Use Mrchnt/CmonNm instead. | o (1) (2) |
Envt/Mrchnt/CmonNm | If sent, then the given merchant name and location that will be included in authorization message. Otherwise, our gateway will use the data from store configuration. | o (1) (2) |
Env/Mrchnt/LctnCtgy | Use value 'NMDC' in case the address is a service location (as needed due to Mastercard mandate AN6022). Otherwise, use value 'FIXD' or don't send this element at all | o (1) (2) |
Envt/Mrchnt/LctnAndCtct/... PstlAdr/AdrLine | .../AdrLine street house-number,city,zip-code or house-number,street,city,zip-code Mapped to below values, if //AdrLine are not given. or .../StrtNm .../BldgNb .../TwnNm .../PstCd .../Ctry .../AddtlCtctInf | o (1) (2) |
Envt/Mrchnt/LctnAndCtct/Email | Ignored. | o (1) (2) |
Envt/Mrchnt/LctnAndCtct/URLAdr | Ignored. | o (1) (2) |
Envt/Mrchnt/LctnAndCtct/Phne | Ignored. | o (1) (2) |
Envt/Mrchnt/LctnAndCtct/CstmrSvc | Ignored. | o (1) (2) |
Envt/POI/Id/Id | In standard case: Gateway terminal ID In Girocard case: Terminal ID from German Banking Industry Committee (GBIC) Will be shared by support team | m (1) |
Envt/POI/Id/Tp | Ignored. | o (1) |
Envt/POI/Id/Issr | Ignored. | o (1) |
Envt/POI/SysNm | Ignored. | o (1) |
Envt/POI/Id/ShrtNm | Only present in case of Girocard case: Gateway Terminal ID. Will be shared by support team. If it gets send for other brands than Girocard, then it must contain the same value as Envt/POI/Id/Id | c (1) |
Envt/POI/GrpId | To be populated with the Gateway store ID. Will be shared by support team | m (1) |
Envt/POI/Cpblties/CardRdngCpblties | According to nexo standard. For terminals supporting contactless single-tap PIN requests, include one additional occurrence with value "OTHR". nexo does not support a dedicated value for this capability yet, but it is expected to be added to future releases. | o (1) |
Envt/POI/Cpblties/CrdhldrVrfctnCpblties | According to nexo standard. | o (1) |
Envt/POI/Cpblties/PINLngthCpblties | Maximum number of digits the POI is able to accept when the cardholder enters its PIN. | o (1) |
Envt/POI/Cpblties/ApprvlCdLngth | Maximum number of characters of the approval code the POI is able to manage. | o (1) |
Envt/POI/Cpblties/MxScrptLngth | Ignored. | o (1) |
Envt/POI/Cpblties/CardCaptrCpbl | Ignored. | o (1) |
Envt/POI/Cpblties/OnLineCpblties | According to nexo standard. | o (1) |
MsgCpblties/... | Ignored. | o (1) |
Envt/POI/TmZone | Ignored. | o (1) |
Envt/POI/TermnlIntgtn | Ignored. | o (1) |
Envt/POI/Cmpnt/Id/...& Envt/POI/Cmpnt/Tp& Envt/POI/Cmpnt/StdCmplc | See link | o (1) |
Envt/POI/Cmpnt/Sts/... | Ignored. | o (1) |
Envt/POI/Cmpnt/Chrtcs/... | Ignored. | o (1) |
Envt/Card/PrtctdCardData/CnttTp | Use value 'EVLP' | o (1) |
Envt/Card/PrtctdCardData/... EnvlpdData/Rcpt/KEK | More information: link | o (1) |
Envt/Card/PrtctdCardData/... EnvlpdData/NcrptdCntt | Contains encrypted card data | o (1) |
Envt/Card/PlainCardData/PAN | Contains card number in plain format, not to be used in productive environment | o (1) |
Envt/Card/PlainCardData/CardSeqNb | Contains card sequence number in plain format, not to be used in productive environment | o (1) |
Envt/Card/PlainCardData/FctvDt | Ignored. | o (1) |
Envt/Card/PlainCardData/XpryDt | Contains card expiry date in plain format, not to be used in productive environment | o (1) |
Envt/Card/PlainCardData/SvcCd | Ignored. | o (1) |
Envt/Card/PlainCardData/Trck1 | Contains track 1 data in plain format, not to be used in productive environment | o (1) |
Envt/Card/PlainCardData/Trck2 | Contains track 2 data in plain format, not to be used in productive environment | o (1) |
Envt/Card/PlainCardData/Trck3 | Contains track 3 data in plain format, not to be used in productive environment | o (1) |
Envt/Card/PlainCardData/CrdhldrNm | Can be used for billing name, not to be used in productive environment. Note that CrdhldrNm is not part of their PlainCardData schema for Completion, cancellation and reversal. | o (1) |
Envt/Card/PmtAcctRef | Token / hosted data value. This field is used to have the possibility to use tokens with length > 35 If this value is set, it is used instead of the card data | o (1) |
Envt/Card/MskdPAN | Ignored. Masked PAN. Recommended format: 497123XXXXXX6123 | o (1) |
Envt/Card/IssrBIN | Only used in AcceptorCurrencyConversionRequest to determine the BIN. More details: link | o (1) |
Envt/Card/CardCtryCd | ISO 3166 – 1, alphanumeric or numeric | o (1) |
Envt/Card/CardCcyCd | ISO 3166 – 1, alphanumeric or numeric | o (1) |
Envt/Card/CardPdctPrfl | Defines a category of cards grouped together for reconciliation. Mandatory in transactions that are relevant for reconciliation. It can be filled with "Card Brand" and not with the actual card product profile as defined in nexo IS in order to allow grouping by brand. | o (1) |
Envt/Card/CardBrnd | Mandatory for sale, preauthorisation and credit transactions. Contains brand of the card with one of: See link | o (1) |
Envt/Card/AddtlCardData | Ignored. | o (1) |
Envt/CstmrDvc | Ignored for card-based sale or preauth, refund or other transactions. Only relevant for AANI. See link | o (1) (2) |
Envt/Wllt/... | Ignored. | o (1) (2) |
Envt/PmtTkn/... | Ignored. | o (1) (2) |
Cntxt/PmtCntxt/CardPres | Card is present or not. | o |
Cntxt/PmtCntxt/CrdhldrPres | Cardholder is present or not. | o |
Cntxt/PmtCntxt/OnLineCntxt | Use 'false' to indicate offline approval. Use 'true' to indicate online approval. If absent, then default value 'true' will be applied. A retransmitted/retry advice is treated as offline regardless. | o |
Cntxt/PmtCntxt/AttndncCntxt | See link | o |
Cntxt/PmtCntxt/TxEnvt | Ignored. | o |
Cntxt/PmtCntxt/TxChanl | TxChanl is only considered for MOTO. See link | o |
Cntxt/PmtCntxt/CardDataNtryMd | According to nexo standard. For Payment with Token use 'CDFL'. If card is not present, use 'DFLE'. For other payments, value indicates the entry mode of the card data (TAGC, PHYS, BRCD, MGST, CICC, DFLE, CTLS, ECTL) | m |
Cntxt/PmtCntxt/FllbckInd | Can be used to Indicate an issue processing data from the chip. Possible values: FFLB - FallbackAfterFailure SFLB - FallbackAfterSuccess NFLB - NoFallback | o |
Cntxt/SaleCntxt/SaleId | See link | o (1) (2) |
Cntxt/SaleCntxt/SaleRefNb | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/SaleRcncltnId | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/CshrId | See link | o (1) (2) |
Cntxt/SaleCntxt/ShftNb | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/PurchsOrdrNb | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/InvcNb | Can be send for reporting purpose. | o (1) (2) |
Cntxt/SaleCntxt/DlvryNoteNb | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/SpnsrdMrchnt/... | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/SpltPmt | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/RmngAmt | Ignored. | o (1) (2) |
Cntxt/SaleCntxt/AddtlSaleData | Ignored. | o (1) (2) |
Tx/MrchntCtgyCd | Merchant category code | m (1) |
Tx/OrgnlTx | Only expected in referenced scenarios such as: Linked refund/return: TxTp='RFND', TxCaptr='true'or Balance or status inquiry, also used for APMs: TxTp='BALC', TxCaptr='false' | o (1) |
SctyTrlr/AuthntcdData | Message Authentication Value - May be disabled or set to optional in our gateway. If set to optional, then a message without MAC is accepted and the response doesn't contain a MAC either. For more information: link | m |
(1) Not available for 'AccptrRcncltnReq'
(2) Not available for 'AccptrCcyConvsReq'
Possible use cases of Traceability element
More details
GUID (Globally Unique Identifier)
| Tag | Description | Presence |
|---|---|---|
Hdr/Tracblt/RlayId/Id | Identification of the entity. For use case 'GUID' use value 'GUID'. By default not required in the request. Only needed in cases where it's explicitly required by the terminal to generate the GUID | o |
Hdr/Tracblt/RlayId/Tp | Type of the identified entity. For use case 'GUID' use value 'ACCP'. By default not required in the request. Only needed in cases where it's explicitly required by the terminal to generate the GUID. | o |
Hdr/Tracblt/RlayId/ShrtNm | Name of the entitiy. Value will be GUID itself calculated by POI. By default not required in the request. Only needed in cases where it's explicitly required by the terminal to generate the GUID | o |
Hdr/Tracblt/TracDtTmIn | Date and time of incoming data exchange for relaying or processing. Required only when Traceability component is used in message. | o |
Hdr/Tracblt/TracDtTmOut | Date and time of outgoing data exchange for relaying or processing. Required only when Traceability component is used in message. | o |
Mastercard Transaction Link Identifier (TLID)
Available soon
| Tag | Description | Presence |
|---|---|---|
Hdr/Tracblt/RlayId/Id | In response: 'IPG:McTLID' | o |
Hdr/Tracblt/RlayId/Tp | In response: 'CISS' (=CardIssuer) | o |
Hdr/Tracblt/RlayId/ShrtNm | In response: Value of TLID | o |
Updated about 8 hours ago
Did this page help you?
