Balance and status inquiry
Normal balance inquiry
In the Nexo Acquirer protocol, you can send an acceptor authorization request to verify the current balance of a preauthorization.
For this purpose, these are the most relevant XML tags in the AccptrAuthstnReq:
| Tag | Presence | Description |
|---|---|---|
`MsgFctn | M | Use value 'AUTQ' |
PmtCntxt.CrdhldrPres | M | Use value 'false' |
PmtCntxt.CardDataNtryMd | M | Use value 'PHYS' |
Tx.TxCaptr | M | Use value 'false' |
Tx.TxTp | M | Use value 'BALC' |
Tx.SaleRefId | M | Contains gateway order ID |
Tx.TxDtls.Ccy | M | Currency of transaction |
Tx.TtlAmt | M | Use value '0' or '0.00' |
Tx.AmtQlfr | M | Use value 'ACTL' |
Example
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.001.001.06" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AccptrAuthstnReq>
<Hdr>
<MsgFctn>AUTQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>305</XchgId>
<CreDtTm>2026-06-12T07:07:57.9+00:00</CreDtTm>
<InitgPty>
<Id>ABCD1234</Id>
<Tp>OPOI</Tp>
<ShrtNm>ABCD1234</ShrtNm>
</InitgPty>
</Hdr>
<AuthstnReq>
<Envt>
<Acqrr>
<Id>
<Id>1</Id>
</Id>
<ParamsVrsn>20190415154918</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>5203xxxx1036</Id>
</Id>
<CmonNm>Merchant 123</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ABCD1234</Id>
<Tp>OPOI</Tp>
<ShrtNm>ABCD1234</ShrtNm>
</Id>
<GrpId>xxxxxxxxxxx</GrpId>
<Cpblties>
<CardRdngCpblties>MGST</CardRdngCpblties>
<CardRdngCpblties>CICC</CardRdngCpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<CardRdngCpblties>PHYS</CardRdngCpblties>
<CrdhldrVrfctnCpblties>FCPN</CrdhldrVrfctnCpblties>
<CrdhldrVrfctnCpblties>FEPN</CrdhldrVrfctnCpblties>
<CrdhldrVrfctnCpblties>NPIN</CrdhldrVrfctnCpblties>
<CrdhldrVrfctnCpblties>OTHR</CrdhldrVrfctnCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CDSP</Dstn>
<AvlblFrmt>TEXT</AvlblFrmt>
<NbOfLines>4</NbOfLines>
<LineWidth>32</LineWidth>
<AvlblLang>bg</AvlblLang>
.
<AvlblLang>sl</AvlblLang>
<AvlblLang>es</AvlblLang>
<AvlblLang>sv</AvlblLang>
</MsgCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<AvlblFrmt>TEXT</AvlblFrmt>
<NbOfLines>4</NbOfLines>
<LineWidth>32</LineWidth>
<AvlblLang>bg</AvlblLang>
<AvlblLang>cs</AvlblLang>
.....
<AvlblLang>es</AvlblLang>
<AvlblLang>sv</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>PAX GLOBAL TECHNOLOGY</PrvdrId>
<Id>PAX Q80</Id>
<SrlNb>1640034439</SrlNb>
</Id>
</Cmpnt>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>TERM_PROVIDER</PrvdrId>
<Id>NEXO ANDROID PAYMENT APPLICATION</Id>
</Id>
<Sts>
<VrsnNb>2.0.28</VrsnNb>
</Sts>
<StdCmplc>
<Id>nexo-IS</Id>
<Vrsn>4.0</Vrsn>
<Issr>nexo</Issr>
</StdCmplc>
<Assmnt>
<Tp>CERT</Tp>
<Assgnr>OSCAR</Assgnr>
<Nb>ToComplete(giveByPayCert)</Nb>
</Assmnt>
</Cmpnt>
</POI>
<Card/>
<Crdhldr>
<Lang>fi</Lang>
</Crdhldr>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<AttndncCntxt>UATT</AttndncCntxt>
<CardDataNtryMd>PHYS</CardDataNtryMd>
</PmtCntxt>
<SaleCntxt>
<SaleId>16516841164</SaleId>
</SaleCntxt>
</Cntxt>
<Tx>
<TxCaptr>false</TxCaptr>
<TxTp>BALC</TxTp>
<MrchntCtgyCd>5499</MrchntCtgyCd>
<SaleRefId>71581515684</SaleRefId>
<TxId>
<TxDtTm>2026-06-12T07:07:57.9+00:00</TxDtTm>
<TxRef>999</TxRef>
</TxId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>0</TtlAmt>
<AmtQlfr>ACTL</AmtQlfr>
<UattnddLvlCtgy>2</UattnddLvlCtgy>
</TxDtls>
</Tx>
</AuthstnReq>
<SctyTrlr>
<CnttTp>AUTH</CnttTp>
<AuthntcdData>
<Rcpt>
<KEK>
<KEKId>
<KeyId>A2MacTestKey</KeyId>
<KeyVrsn>2016051911</KeyVrsn>
<DerivtnId>EAM3AAA=</DerivtnId>
</KEKId>
<KeyNcrptnAlgo>
<Algo>DKP9</Algo>
</KeyNcrptnAlgo>
<NcrptdKey>HJxAUl4=</NcrptdKey>
</KEK>
</Rcpt>
<MACAlgo>
<Algo>MCCS</Algo>
</MACAlgo>
<NcpsltdCntt>
<CnttTp>DATA</CnttTp>
</NcpsltdCntt>
<MAC>Cj+5EM7OKvc=</MAC>
</AuthntcdData>
</SctyTrlr>
</AccptrAuthstnReq>
</Document>
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.002.001.06">
<AccptrAuthstnRspn>
<Hdr>
<MsgFctn>AUTP</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>305</XchgId>
<CreDtTm>2026-06-12T09:07:59.855+02:00</CreDtTm>
<InitgPty>
<Id>ABCD1234</Id>
</InitgPty>
</Hdr>
<AuthstnRspn>
<Envt>
<AcqrrId>
<Id>1</Id>
</AcqrrId>
<MrchntId>
<Id>5203xxxx1036</Id>
</MrchntId>
<POIId>
<Id>ABCD1234</Id>
<ShrtNm>ABCD1234</ShrtNm>
</POIId>
<Card>
<MskdPAN>455870XXXXXX9403</MskdPAN>
<CardBrnd>V</CardBrnd>
<CardPdctSubTp>0006</CardPdctSubTp>
</Card>
</Envt>
<Tx>
<TxId>
<TxDtTm>2026-06-12T07:07:57.9+00:00</TxDtTm>
<TxRef>999</TxRef>
</TxId>
<RcptTxId>71581515684</RcptTxId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>0</TtlAmt>
<VldtyDt>2026-06-26+02:00</VldtyDt>
<ICCRltdData>(emv tags)</ICCRltdData>
</TxDtls>
</Tx>
<TxRspn>
<AuthstnRslt>
<AuthstnNtty>
<Tp>CISS</Tp>
</AuthstnNtty>
<RspnToAuthstn>
<Rspn>APPR</Rspn>
<RspnRsn>00:Function performed error-free</RspnRsn>
</RspnToAuthstn>
<AuthstnCd>123790</AuthstnCd>
<CmpltnReqrd>false</CmpltnReqrd>
</AuthstnRslt>
<Bal>
<Amt Ccy="EUR">1.00</Amt>
</Bal>
</TxRspn>
</AuthstnRspn>
<SctyTrlr>
<CnttTp>AUTH</CnttTp>
<AuthntcdData>
<Rcpt>
<KEK>
<KEKId>
<KeyId>A2MacTestKey</KeyId>
<KeyVrsn>2016051911</KeyVrsn>
<DerivtnId>EAM3AAA=</DerivtnId>
</KEKId>
<KeyNcrptnAlgo>
<Algo>DKP9</Algo>
</KeyNcrptnAlgo>
<NcrptdKey>HJxAUl4=</NcrptdKey>
</KEK>
</Rcpt>
<MACAlgo>
<Algo>MCCS</Algo>
</MACAlgo>
<NcpsltdCntt>
<CnttTp>DATA</CnttTp>
</NcpsltdCntt>
<MAC>xFATl/IdQrk=</MAC>
</AuthntcdData>
</SctyTrlr>
</AccptrAuthstnRspn>
</Document>
success of balance inquiry
The balance inquiry will only be successful, if the preauthorization is still valid and the amount is bigger than 0. In all other cases, the balance inquiry will be rejected.
Extended balance inquiry
Beyond a normal balance inquiry, it is possible to retrieve additional information about a transaction. You can even receive information about a preauthoization that has already been completed or got expired. For this purpose, you can use our extended balance inquiry by additionally sending the following XML tag in the AccptrAuthstnReq.
| Tag | Presence | Description |
|---|---|---|
AddtlTxData | C | Use value '/SuccessOnCompletedPreauth' |
In addition to the response to a normal balance inquiry, you will receive the following information.
| Tag | Presence | Description |
|---|---|---|
AddtlRspnInf | M | Contains information related to the referenced order ID formatted as key-value-pairs: - LastTxType: last transaction - PEM: pos entry mode of last transaction - ReturnedAmount: sum of refunds - TotalAmount: sum of sale transactions |
Example
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.001.001.06" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AccptrAuthstnReq>
<Hdr>
<MsgFctn>AUTQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>305</XchgId>
<CreDtTm>2026-06-12T08:38:33.6+01:00</CreDtTm>
<InitgPty>
<Id>ABCD1234</Id>
<Tp>OPOI</Tp>
<ShrtNm>ABCD1234</ShrtNm>
</InitgPty>
</Hdr>
<AuthstnReq>
<Envt>
<Acqrr>
<Id>
<Id>1</Id>
</Id>
<ParamsVrsn>20260612040713</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>520xxxxxx1038</Id>
</Id>
<CmonNm>Selecta
Vending</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ABCD1234</Id>
<Tp>OPOI</Tp>
<ShrtNm>ABCD1234</ShrtNm>
</Id>
<Cpblties>
<CardRdngCpblties>MGST</CardRdngCpblties>
<CardRdngCpblties>CICC</CardRdngCpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<CrdhldrVrfctnCpblties>FCPN</CrdhldrVrfctnCpblties>
<CrdhldrVrfctnCpblties>FEPN</CrdhldrVrfctnCpblties>
<CrdhldrVrfctnCpblties>NPIN</CrdhldrVrfctnCpblties>
<CrdhldrVrfctnCpblties>OTHR</CrdhldrVrfctnCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CDSP</Dstn>
<AvlblFrmt>TEXT</AvlblFrmt>
<NbOfLines>4</NbOfLines>
<LineWidth>32</LineWidth>
<AvlblLang>bg</AvlblLang>
...
<AvlblLang>es</AvlblLang>
<AvlblLang>sv</AvlblLang>
</MsgCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<AvlblFrmt>TEXT</AvlblFrmt>
<NbOfLines>4</NbOfLines>
<LineWidth>32</LineWidth>
<AvlblLang>bg</AvlblLang>
...
<AvlblLang>es</AvlblLang>
<AvlblLang>sv</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>TERM_PROVIDER_NAME</PrvdrId>
<Id>NEXO ANDROID PAYMENT APPLICATION</Id>
</Id>
<Sts>
<VrsnNb>2.0.28</VrsnNb>
</Sts>
<StdCmplc>
<Id>nexo-IS</Id>
<Vrsn>4.0</Vrsn>
<Issr>nexo</Issr>
</StdCmplc>
<Assmnt>
<Tp>CERT</Tp>
<Assgnr>OSCAR</Assgnr>
<Nb>ToComplete(giveByPayCert)</Nb>
</Assmnt>
</Cmpnt>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>PAX GLOBAL TECHNOLOGY</PrvdrId>
<Id>IM30</Id>
<SrlNb>1640047824</SrlNb>
</Id>
</Cmpnt>
</POI>
<Card/>
<Crdhldr>
<Lang>sv</Lang>
</Crdhldr>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<AttndncCntxt>UATT</AttndncCntxt>
<AttndntLang>sv</AttndntLang>
<CardDataNtryMd>PHYS</CardDataNtryMd>
</PmtCntxt>
<SaleCntxt>
<SaleId>1640047824</SaleId>
</SaleCntxt>
</Cntxt>
<Tx>
<TxCaptr>false</TxCaptr>
<TxTp>BALC</TxTp>
<MrchntCtgyCd>5499</MrchntCtgyCd>
<SaleRefId>1786584455</SaleRefId>
<TxId>
<TxDtTm>2026-06-12T08:38:33.6+01:00</TxDtTm>
<TxRef>999</TxRef>
</TxId>
<TxDtls>
<Ccy>SEK</Ccy>
<TtlAmt>0.00</TtlAmt>
<AmtQlfr>ACTL</AmtQlfr>
</TxDtls>
<AddtlTxData>/SuccessOnCompletedPreauth</AddtlTxData>
</Tx>
</AuthstnReq>
<SctyTrlr>
<CnttTp>AUTH</CnttTp>
<AuthntcdData>
<Rcpt>
<KEK>
<KEKId>
<KeyId>A2MacTestKey</KeyId>
<KeyVrsn>2016051911</KeyVrsn>
<DerivtnId>EAM3AAA=</DerivtnId>
</KEKId>
<KeyNcrptnAlgo>
<Algo>DKP9</Algo>
</KeyNcrptnAlgo>
<NcrptdKey>Ez4AArs=</NcrptdKey>
</KEK>
</Rcpt>
<MACAlgo>
<Algo>MCCS</Algo>
</MACAlgo>
<NcpsltdCntt>
<CnttTp>DATA</CnttTp>
</NcpsltdCntt>
<MAC>+aqiKlBSRy0=</MAC>
</AuthntcdData>
</SctyTrlr>
</AccptrAuthstnReq>
</Document>
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.002.001.06">
<AccptrAuthstnRspn>
<Hdr>
<MsgFctn>AUTP</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>305</XchgId>
<CreDtTm>2026-06-12T09:38:41.174+02:00</CreDtTm>
<InitgPty>
<Id>ABCD1234</Id>
</InitgPty>
</Hdr>
<AuthstnRspn>
<Envt>
<AcqrrId>
<Id>1</Id>
</AcqrrId>
<MrchntId>
<Id>520xxxxxx1038</Id>
</MrchntId>
<POIId>
<Id>ABCD1234</Id>
<ShrtNm>ABCD1234</ShrtNm>
</POIId>
<Card>
<MskdPAN>467405XXXXXX9105</MskdPAN>
<CardBrnd>V</CardBrnd>
<CardPdctSubTp>0024</CardPdctSubTp>
</Card>
</Envt>
<Tx>
<TxId>
<TxDtTm>2026-06-12T08:38:33.6+01:00</TxDtTm>
<TxRef>999</TxRef>
</TxId>
<RcptTxId>1786584455</RcptTxId>
<TxDtls>
<Ccy>SEK</Ccy>
<TtlAmt>0.00</TtlAmt>
<ICCRltdData>34MEgbGfAgYAAAAAIQCfAwYAAAAAAACfJgi19Ca/19eFU4ICAGCHAQGfCgQAAQEBnzYCALifCQIAlp8nAYCEB6AAAAADEBCfbgQjiAAAnx4INDAwNDc4MjSfECAfQmMyoAAAAAAQAwJzAAAAAEAAAAAAAAAAAAAAAAAAAN84AQOfMwNgWMifGgIHUp9mBDagQACfNQEllQUAAAAAAF8qAgdSmgMmBhKfQQIgUZwBAJ83BCYIXAffgwUOigIwMJEIwCEq4ACGAAA=</ICCRltdData>
</TxDtls>
</Tx>
<TxRspn>
<AuthstnRslt>
<AuthstnNtty>
<Tp>CISS</Tp>
</AuthstnNtty>
<RspnToAuthstn>
<Rspn>APPR</Rspn>
<RspnRsn>00:Function performed error-free</RspnRsn>
<AddtlRspnInf>LastTxType=CRDP;PEM=ECTL;ReturnedAmount=0.00;TotalAmount=21.00</AddtlRspnInf>
</RspnToAuthstn>
<AuthstnCd>996942</AuthstnCd>
<CmpltnReqrd>false</CmpltnReqrd>
</AuthstnRslt>
<Bal>
<Amt Ccy="SEK">0.00</Amt>
</Bal>
</TxRspn>
</AuthstnRspn>
<SctyTrlr>
<CnttTp>AUTH</CnttTp>
<AuthntcdData>
<Rcpt>
<KEK>
<KEKId>
<KeyId>A2MacTestKey</KeyId>
<KeyVrsn>2016051911</KeyVrsn>
<DerivtnId>EAM3AAA=</DerivtnId>
</KEKId>
<KeyNcrptnAlgo>
<Algo>DKP9</Algo>
</KeyNcrptnAlgo>
<NcrptdKey>Ez4AArs=</NcrptdKey>
</KEK>
</Rcpt>
<MACAlgo>
<Algo>MCCS</Algo>
</MACAlgo>
<NcpsltdCntt>
<CnttTp>DATA</CnttTp>
</NcpsltdCntt>
<MAC>coDHEic2ziM=</MAC>
</AuthntcdData>
</SctyTrlr>
</AccptrAuthstnRspn>
</Document>
