THIS PAGE ACCESS IS CURRENTLY RESTRICTED TO AUTHORIZED USERS ONLY.
PLEASE DO NOT PUBLISH THE PAGE WITHOUT THE PRODUCT OWNER PERMISSION
Definition
…
Reference Documents
…
Processing
The Cancellation Service can be performed and processed in three ways:
...
Offline Cancellation
...
In this section:
Table of Contents | ||||
---|---|---|---|---|
|
Definition
A Cancellation is a transaction initiated by an Acceptor to cancel a payment which was successfully completed. The Cancellation service is also known as a Reversal. A Cancellation cannot be revoked.
Reference Documents
nexo Card Payment Message Usage Guide
nexo-FAST
Processing
The Cancellation service can be performed and processed in three ways:
Offline Cancellation | The Acceptor shall be aware that the transaction was not yet cleared: an AcceptorCancellationAdvice is sent to the Acquirer without an AcceptorCancellationRequest. |
Online Cancellation using the transaction log |
...
Online Cancellation without searching from the log
The Acceptor perform a search of the transaction log. If the transaction log is found, the Acceptor then asks the Acquirer whether a cancellation can be performed by sending an AcceptorCancellationRequest before sending an AcceptorCancellationAdvice. The AcceptorCancellationRequest may contain some information of the payment transaction to be cancelled. |
Online Cancellation without searching from the log |
Configuration
Enable Cancellation Service
To enable the Cancellation Service:
...
Define the Cancellation Service proprieties in the Service Settings Table (E4).
...
Add the Cancellation Service in the list of configured service in Terminal Data (E1) using:
'DF13' - Configured Services[1, 6] = 1b (Cancellation)
or'DF67' - Configured Services Extended[1, 6] = 1b (Cancellation)
or
Specify which payment services can be cancelled:
...
To allow the Cancellation of Payment, set 'DF28' - Application Profile Settings(APS) for Cancellation [1, 8] = 1b (Cancellation of Payment)
...
To allow the Cancellation of Refund, set 'DF28' - Application Profile Settings(APS) for Cancellation [1, 7] = 1b (Cancellation of Refund)
...
The Acceptor asks the Acquirer whether a cancellation can be performed by sending an AcceptorCancellationRequest before sending an AcceptorCancellationAdvice. The AcceptorCancellationRequest may contain some information of the payment transaction to be cancelled. |
Note |
---|
Online Cancellation Reversal An Online Cancellation can be reversed in the same way as an online authorization if:
|
Note |
---|
Cancellation Advice following a Cancellation Request An Online Cancellation Request declined by the acquirer will NOT result in Cancellation advice. See the attached picture below for more information. |
Configuration
Enable Cancellation Service
To enable the Cancellation Service:
Define the Cancellation Service proprieties in the Service Settings Table (E4).
Add the Cancellation Service in the list of configured service in Terminal Data (E1) using:
'DF13' - Configured Services[1, 6] = 1b (Cancellation)
or'DF67' - Configured Services Extended[1, 6] = 1b (Cancellation
...
)
Specify which payment services can be cancelled:
To allow the Cancellation of Payment
...
, set
'DF28' - Application Profile Settings(APS) for Cancellation [1,
...
8] = 1b (Cancellation of Payment
...
)
To allow the Cancellation of
...
Refund, set
'DF28' - Application Profile Settings(APS) for Cancellation [1,
...
7] = 1b (Cancellation of
...
Refund)
Enable Offline Cancellation
The Cancellation Service processing mode is configurable per Application Profile (E6).
To enable Offline Cancellation:
...
To allow the Cancellation of Pre-Authorization, set
'DF28' - Application Profile Settings(APS) for Cancellation [
...
1,
...
6] =
...
1b (Cancellation of Pre-Authorisation)
To allow the Cancellation of Payment Completion, set
'DF28' - Application Profile Settings(APS) for Cancellation [
...
1,
...
5] =
...
1b (Cancellation of Payment Completion)
To allow the Cancellation of Cash Advance, set
'DF28' - Application Profile Settings(APS) for Cancellation [1, 4] = 1b (Cancellation of Cash Advance)
Setting Cancellation processing mode (Offline or Online)
The Cancellation Service processing mode is configurable per Application Profile (E6) using the 'DF28' - Application Profile Settings(APS) for Cancellation
.
Offline Cancellation Settings
To enable
...
Offline Cancellation:
Set
'DF28' - Application Profile Settings(APS) for Cancellation [2, 8] =
...
0b (Cancellation shall be performed
...
offline (without Online Approval Request) for transactions that are neither captured nor reconciled)
.Set
'DF28' - Application Profile Settings(APS) for Cancellation [2, 6] =
...
0b (Cancellation shall be performed
...
offline (without Online Approval Request) for captured transactions)
.
Message Examples
To be completed
. From now on, a merchant is able to do :
Online Cancellation using the transaction log
Note |
---|
Offline Cancellation is done through a search |
...
in the transaction log |
...
Steps Taken for a successful online cancellation:
Terminal Settings ( Tag DF34 byte 3, bit 6 set to 0 , bit 7 set to 1).
...
Ensure that Application Profile Settings for Cancellation (Tag DF28) is configured for the service you want to cancel(byte 1) and is configured to be performed online(byte 2). NOTE: In our case, it is configured online for captured transaction.
Below is an example derived from a cancellation of an original transaction(payment).
Code Block |
---|
PaymentResult result;
result = arkos.doPayment(arkosConfig.AsBytes(), paymentParams.AsBytes()); //In your payment function
paymentParams.AddAscii(ArkosTags.ReferenceData,result.trxReference); //In your cancellation function |
Examples of the use cases with their corresponding XML can be found below.
AcceptorCancellationRequest:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.005.001.06">
<AccptrCxlReq>
<Hdr>
<MsgFctn>CCAQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>0</XchgId>
<CreDtTm>2021-06-21T01:36:05.000+00:00</CreDtTm>
<InitgPty>
<Id>UBUNTU</Id>
</InitgPty>
<RcptPty>
<Id>NATIXIS</Id>
</RcptPty>
</Hdr>
<CxlReq>
<Envt>
<Acqrr>
<Id>
<Id>010009287351</Id>
</Id>
<ParamsVrsn>1.0</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>00000NEXOMER001</Id>
</Id>
<CmonNm>AMADIS 1111 Saint-Urbain Montréal</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ASA00001</Id>
</Id>
<Cpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<Dstn>MDSP</Dstn>
<Dstn>MRCP</Dstn>
<AvlblLang>en</AvlblLang>
<AvlblLang>fr</AvlblLang>
<AvlblLang>it</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>MANUFACTURER</PrvdrId>
<Id>MODEL</Id>
<SrlNb>DEVICESN</SrlNb>
</Id>
<Sts />
</Cmpnt>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>AMADIS</PrvdrId>
<Id>ARKOS</Id>
</Id>
<Sts>
<VrsnNb>2.0</VrsnNb>
</Sts>
</Cmpnt>
</POI>
<Card>
<PlainCardData>
<PAN>5219610200140517</PAN>
<XpryDt>2021-08</XpryDt>
</PlainCardData>
<CardPdctPrfl>04</CardPdctPrfl>
<CardBrnd>Carte a Piste</CardBrnd>
</Card>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<AttndncCntxt>ATTD</AttndncCntxt>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</PmtCntxt>
</Cntxt>
<Tx>
<TxCaptr>false</TxCaptr>
<MrchntCtgyCd>5555</MrchntCtgyCd>
<TxId>
<TxDtTm>2021-06-21T01:36:05.000+00:00</TxDtTm>
<TxRef>00000029</TxRef>
</TxId>
<OrgnlTx>
<TxId>
<TxDtTm>2021-06-21T01:36:00.000+00:00</TxDtTm>
<TxRef>00000028</TxRef>
</TxId>
<POIId>
<Id>ASA00001</Id>
</POIId>
<TxTp>CRDP</TxTp>
<CardDataNtryMd>DFLE</CardDataNtryMd>
<TxRslt>
<RspnToAuthstn>
<Rspn>APPR</Rspn>
</RspnToAuthstn>
<AuthstnCd>000534</AuthstnCd>
</TxRslt>
</OrgnlTx>
<RcncltnId>1</RcncltnId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>89.12</TtlAmt>
</TxDtls>
</Tx>
</CxlReq>
</AccptrCxlReq>
</Document> |
AcceptorCancellationAdvice:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.007.001.06">
<AccptrCxlAdvc>
<Hdr>
<MsgFctn>CCAQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>0</XchgId>
<ReTrnsmssnCntr>1</ReTrnsmssnCntr>
<CreDtTm>2021-06-21T01:36:05.000+00:00</CreDtTm>
<InitgPty>
<Id>UBUNTU</Id>
</InitgPty>
<RcptPty>
<Id>NATIXIS</Id>
</RcptPty>
</Hdr>
<CxlAdvc>
<Envt>
<Acqrr>
<Id>
<Id>010009287351</Id>
</Id>
<ParamsVrsn>1.0</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>00000NEXOMER001</Id>
</Id>
<CmonNm>AMADIS 1111 Saint-Urbain Montréal</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ASA00001</Id>
</Id>
<Cpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<Dstn>MDSP</Dstn>
<Dstn>MRCP</Dstn>
<AvlblLang>en</AvlblLang>
<AvlblLang>fr</AvlblLang>
<AvlblLang>it</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>MANUFACTURER</PrvdrId>
<Id>MODEL</Id>
<SrlNb>DEVICESN</SrlNb>
</Id>
<Sts />
</Cmpnt>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>AMADIS</PrvdrId>
<Id>ARKOS</Id>
</Id>
<Sts>
<VrsnNb>2.0</VrsnNb>
</Sts>
</Cmpnt>
</POI>
<Card>
<PlainCardData>
<PAN>5219610200140517</PAN>
<XpryDt>2021-08</XpryDt>
</PlainCardData>
<IssrBIN>52196102</IssrBIN>
<CardPdctPrfl>04</CardPdctPrfl>
<CardBrnd>Carte a Piste</CardBrnd>
</Card>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<OnLineCntxt>true</OnLineCntxt>
<AttndncCntxt>ATTD</AttndncCntxt>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</PmtCntxt>
</Cntxt>
<Tx>
<MrchntCtgyCd>5555</MrchntCtgyCd>
<TxId>
<TxDtTm>2021-06-21T01:36:05.000+00:00</TxDtTm>
<TxRef>00000029</TxRef>
</TxId>
<OrgnlTx>
<TxId>
<TxDtTm>2021-06-21T01:36:00.000+00:00</TxDtTm>
<TxRef>00000028</TxRef>
</TxId>
<POIId>
<Id>ASA00001</Id>
</POIId>
<TxTp>CRDP</TxTp>
<CardDataNtryMd>DFLE</CardDataNtryMd>
<TxRslt>
<RspnToAuthstn>
<Rspn>APPR</Rspn>
</RspnToAuthstn>
<AuthstnCd>000534</AuthstnCd>
</TxRslt>
</OrgnlTx>
<TxSucss>true</TxSucss>
<Rvsl>false</Rvsl>
<RcncltnId>1</RcncltnId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>89.12</TtlAmt>
</TxDtls>
</Tx>
</CxlAdvc>
</AccptrCxlAdvc>
</Document> |
Offline Cancellation
Offline cancellations are done through a search in the transaction log as well. Performing an offline cancellation involves the following steps explained below.
Steps Taken for a successful offline cancellation:
Terminal Settings ( Tag DF34 byte 3, bit 6 set to 0 , bit 7 set to 1).
...
Ensure that Application Profile Settings for Cancellation (Tag DF28) is configured for the service you want to cancel(byte 1) and is configured to be performed offline(byte 2). NOTE: In our case, it is configured offline for captured transaction.
Below is an example derived from a cancellation of an original transaction(payment).
Code Block |
---|
PaymentResult result;
result = arkos.doPayment(arkosConfig.AsBytes(), paymentParams.AsBytes()); //In your payment function
paymentParams.AddAscii(ArkosTags.ReferenceData,result.trxReference); //In your cancellation function |
Examples of the use cases with their corresponding XML can be found below.
AcceptorCancellationAdvice:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.007.001.06">
<AccptrCxlAdvc>
<Hdr>
<MsgFctn>CCAQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>0</XchgId>
<ReTrnsmssnCntr>1</ReTrnsmssnCntr>
<CreDtTm>2021-06-21T02:03:26.000+00:00</CreDtTm>
<InitgPty>
<Id>UBUNTU</Id>
</InitgPty>
<RcptPty>
<Id>NATIXIS</Id>
</RcptPty>
</Hdr>
<CxlAdvc>
<Envt>
<Acqrr>
<Id>
<Id>010009287351</Id>
</Id>
<ParamsVrsn>1.0</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>00000NEXOMER001</Id>
</Id>
<CmonNm>AMADIS 1111 Saint-Urbain Montréal</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ASA00001</Id>
</Id>
<Cpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<Dstn>MDSP</Dstn>
<Dstn>MRCP</Dstn>
<AvlblLang>en</AvlblLang>
<AvlblLang>fr</AvlblLang>
<AvlblLang>it</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>MANUFACTURER</PrvdrId>
<Id>MODEL</Id>
<SrlNb>DEVICESN</SrlNb>
</Id>
<Sts />
</Cmpnt>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>AMADIS</PrvdrId>
<Id>ARKOS</Id>
</Id>
<Sts>
<VrsnNb>2.0</VrsnNb>
</Sts>
</Cmpnt>
</POI>
<Card>
<PlainCardData>
<PAN>5219610200140517</PAN>
<XpryDt>2021-08</XpryDt>
</PlainCardData>
<IssrBIN>52196102</IssrBIN>
<CardPdctPrfl>04</CardPdctPrfl>
<CardBrnd>Carte a Piste</CardBrnd>
</Card>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<OnLineCntxt>false</OnLineCntxt>
<AttndncCntxt>ATTD</AttndncCntxt>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</PmtCntxt>
</Cntxt>
<Tx>
<MrchntCtgyCd>5555</MrchntCtgyCd>
<TxId>
<TxDtTm>2021-06-21T02:03:26.000+00:00</TxDtTm>
<TxRef>00000032</TxRef>
</TxId>
<OrgnlTx>
<TxId>
<TxDtTm>2021-06-21T02:03:23.000+00:00</TxDtTm>
<TxRef>00000031</TxRef>
</TxId>
<POIId>
<Id>ASA00001</Id>
</POIId>
<TxTp>CRDP</TxTp>
<CardDataNtryMd>DFLE</CardDataNtryMd>
<TxRslt>
<RspnToAuthstn>
<Rspn>APPR</Rspn>
</RspnToAuthstn>
<AuthstnCd>000535</AuthstnCd>
</TxRslt>
</OrgnlTx>
<TxSucss>true</TxSucss>
<Rvsl>false</Rvsl>
<RcncltnId>1</RcncltnId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>89.12</TtlAmt>
</TxDtls>
</Tx>
</CxlAdvc>
</AccptrCxlAdvc>
</Document> |
Online Cancellation without searching from the log
It is to be noted that a slight modification was made to the flow of the latter (Online Cancellation without searching from the log) to help retrieve some Infos; such as AcquirerID, TerminalID, and etc. As it stands, this seems to be lackluster from Nexofast as they haven't thought out this solution properly. Upon implementing the flow they provided to us (nexoFAST 3.2), we ended up having some issues.
A new function was introduced as a solution to the problem.
The function setSelectedApplicationProfileNumberToDefaultFromServiceEntry
allows us to set a profile, initialized the application, and finally, construct valid messages.
Below is the modified diagram.
...
Steps Taken for a successful online cancellation:
Terminal Settings ( Tag DF34 byte 3, bit 6 set to 1 , bit 7 set to 0).
...
Reference data has been included in the Original Transaction section of CancellationRequest and CancellationAdvice.
Below is an example derived from a cancellation of an original transaction(payment).
Code Block |
---|
paymentParams.AddBin(ArkosTags.TransactionAmount, new byte[] { 0x00, 0x00, 0x00, 0x00, 0x20, 0x00 });
paymentParams.AddBin(ArkosTags.AmountAuthorised, new byte[] { 0x00, 0x00, 0x00, 0x00, 0x20, 0x00 });
paymentParams.AddBin(ArkosTags.TransactionAmountBeforeAdjustment, new byte[] { 0x00, 0x00, 0x00, 0x00, 0x20, 0x00 });
TlvTree originalTransaction = paymentParams.AddChild(ArkosTags.OriginalTransaction);
originalTransaction.AddEMVDate(ArkosTags.TransactionDate, cal.get(Calendar.YEAR) % 100, cal.get(Calendar.MONTH) + 1, cal.get(Calendar.DAY_OF_MONTH));
originalTransaction.AddEMVTime(ArkosTags.TransactionTime, cal.get(Calendar.HOUR), cal.get(Calendar.MINUTE), cal.get(Calendar.SECOND));
originalTransaction.AddBin(ArkosTags.LocalTimezone, utcOffset);
originalTransaction.AddAscii(ArkosTags.ReferenceData,"1234567890");
originalTransaction.AddEnum(ArkosTags.SelectedService, PaymentServiceID.Payment);
paymentParams.AddAscii(ArkosTags.ReferenceData,"1234567890"); |
Examples of the use cases with their corresponding XML can be found below.
AcceptorCancellationRequest:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.005.001.06">
<AccptrCxlReq>
<Hdr>
<MsgFctn>CCAQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>0</XchgId>
<CreDtTm>2021-06-21T00:30:03.000+00:00</CreDtTm>
<InitgPty>
<Id>UBUNTU</Id>
</InitgPty>
<RcptPty>
<Id>NATIXIS</Id>
</RcptPty>
</Hdr>
<CxlReq>
<Envt>
<Acqrr>
<Id>
<Id>010009287351</Id>
</Id>
<ParamsVrsn>1.0</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>00000NEXOMER001</Id>
</Id>
<CmonNm>AMADIS 1111 Saint-Urbain Montréal</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ASA00001</Id>
</Id>
<Cpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<Dstn>MDSP</Dstn>
<Dstn>MRCP</Dstn>
<AvlblLang>en</AvlblLang>
<AvlblLang>fr</AvlblLang>
<AvlblLang>it</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>MANUFACTURER</PrvdrId>
<Id>MODEL</Id>
<SrlNb>ASADEVSN</SrlNb>
</Id>
<Sts />
</Cmpnt>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>AMADIS</PrvdrId>
<Id>ARKOS</Id>
</Id>
<Sts>
<VrsnNb>2.0</VrsnNb>
</Sts>
</Cmpnt>
</POI>
<Card>
<CardPdctPrfl>04</CardPdctPrfl>
<CardBrnd>Carte a Piste</CardBrnd>
</Card>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<AttndncCntxt>ATTD</AttndncCntxt>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</PmtCntxt>
</Cntxt>
<Tx>
<TxCaptr>false</TxCaptr>
<MrchntCtgyCd>5555</MrchntCtgyCd>
<TxId>
<TxDtTm>2021-06-21T00:30:03.000+00:00</TxDtTm>
<TxRef>00000026</TxRef>
</TxId>
<OrgnlTx>
<TxId>
<TxDtTm>2021-06-21T00:30:03.000+00:00</TxDtTm>
<TxRef>1234567890</TxRef>
</TxId>
<TxTp>CRDP</TxTp>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</OrgnlTx>
<RcncltnId>1</RcncltnId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>20.00</TtlAmt>
</TxDtls>
</Tx>
</CxlReq>
</AccptrCxlReq>
</Document> |
AcceptorCancellationAdvice:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.007.001.06">
<AccptrCxlAdvc>
<Hdr>
<MsgFctn>CCAQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>0</XchgId>
<ReTrnsmssnCntr>1</ReTrnsmssnCntr>
<CreDtTm>2021-06-21T00:30:03.000+00:00</CreDtTm>
<InitgPty>
<Id>UBUNTU</Id>
</InitgPty>
<RcptPty>
<Id>NATIXIS</Id>
</RcptPty>
</Hdr>
<CxlAdvc>
<Envt>
<Acqrr>
<Id>
<Id>010009287351</Id>
</Id>
<ParamsVrsn>1.0</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>00000NEXOMER001</Id>
</Id>
<CmonNm>AMADIS 1111 Saint-Urbain Montréal</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ASA00001</Id>
</Id>
<Cpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<Dstn>MDSP</Dstn>
<Dstn>MRCP</Dstn>
<AvlblLang>en</AvlblLang>
<AvlblLang>fr</AvlblLang>
<AvlblLang>it</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>MANUFACTURER</PrvdrId>
<Id>MODEL</Id>
<SrlNb>ASADEVSN</SrlNb>
</Id>
<Sts />
</Cmpnt>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>AMADIS</PrvdrId>
<Id>ARKOS</Id>
</Id>
<Sts>
<VrsnNb>2.0</VrsnNb>
</Sts>
</Cmpnt>
</POI>
<Card>
<CardPdctPrfl>04</CardPdctPrfl>
<CardBrnd>Carte a Piste</CardBrnd>
</Card>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<OnLineCntxt>true</OnLineCntxt>
<AttndncCntxt>ATTD</AttndncCntxt>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</PmtCntxt>
</Cntxt>
<Tx>
<MrchntCtgyCd>5555</MrchntCtgyCd>
<TxId>
<TxDtTm>2021-06-21T00:30:03.000+00:00</TxDtTm>
<TxRef>00000026</TxRef>
</TxId>
<OrgnlTx>
<TxId>
<TxDtTm>2021-06-21T00:30:03.000+00:00</TxDtTm>
<TxRef>1234567890</TxRef>
</TxId>
<TxTp>CRDP</TxTp>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</OrgnlTx>
<TxSucss>true</TxSucss>
<Rvsl>false</Rvsl>
<RcncltnId>1</RcncltnId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>20.00</TtlAmt>
</TxDtls>
</Tx>
</CxlAdvc>
</AccptrCxlAdvc>
</Document> |
Transaction Reversal
An online cancellation can be reversed in the same way as an online authorization during payment if we don't receive any message or if an incident happened after authorization. An online cancellation that received a DECLINED response from the acquirer will NOT result in completion advice.
Below is the obtained cancellation advice XML.
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.007.001.06">
<AccptrCxlAdvc>
<Hdr>
<MsgFctn>CCAQ</MsgFctn>
<PrtcolVrsn>6.0</PrtcolVrsn>
<XchgId>0</XchgId>
<ReTrnsmssnCntr>1</ReTrnsmssnCntr>
<CreDtTm>2021-06-21T10:40:24.000+00:00</CreDtTm>
<InitgPty>
<Id>UBUNTU</Id>
</InitgPty>
<RcptPty>
<Id>NATIXIS</Id>
</RcptPty>
</Hdr>
<CxlAdvc>
<Envt>
<Acqrr>
<Id>
<Id>010009287351</Id>
</Id>
<ParamsVrsn>1.0</ParamsVrsn>
</Acqrr>
<Mrchnt>
<Id>
<Id>00000NEXOMER001</Id>
</Id>
<CmonNm>AMADIS 1111 Saint-Urbain Montréal</CmonNm>
</Mrchnt>
<POI>
<Id>
<Id>ASA00001</Id>
</Id>
<Cpblties>
<CardRdngCpblties>ECTL</CardRdngCpblties>
<ApprvlCdLngth>6</ApprvlCdLngth>
<OnLineCpblties>SMON</OnLineCpblties>
<MsgCpblties>
<Dstn>CRCP</Dstn>
<Dstn>MDSP</Dstn>
<Dstn>MRCP</Dstn>
<AvlblLang>en</AvlblLang>
<AvlblLang>fr</AvlblLang>
<AvlblLang>it</AvlblLang>
</MsgCpblties>
</Cpblties>
<Cmpnt>
<Tp>TERM</Tp>
<Id>
<PrvdrId>MANUFACTURER</PrvdrId>
<Id>MODEL</Id>
<SrlNb>DEVICESN</SrlNb>
</Id>
<Sts />
</Cmpnt>
<Cmpnt>
<Tp>APLI</Tp>
<Id>
<PrvdrId>AMADIS</PrvdrId>
<Id>ARKOS</Id>
</Id>
<Sts>
<VrsnNb>2.0</VrsnNb>
</Sts>
</Cmpnt>
</POI>
<Card>
<PlainCardData>
<PAN>5219610200140517</PAN>
<XpryDt>2021-08</XpryDt>
</PlainCardData>
<IssrBIN>52196102</IssrBIN>
<CardPdctPrfl>04</CardPdctPrfl>
<CardBrnd>Carte a Piste</CardBrnd>
</Card>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>false</CardPres>
<CrdhldrPres>false</CrdhldrPres>
<OnLineCntxt>true</OnLineCntxt>
<AttndncCntxt>ATTD</AttndncCntxt>
<CardDataNtryMd>DFLE</CardDataNtryMd>
</PmtCntxt>
</Cntxt>
<Tx>
<MrchntCtgyCd>5555</MrchntCtgyCd>
<TxId>
<TxDtTm>2021-06-21T10:40:24.000+00:00</TxDtTm>
<TxRef>00000022</TxRef>
</TxId>
<OrgnlTx>
<TxId>
<TxDtTm>2021-06-21T10:40:20.000+00:00</TxDtTm>
<TxRef>00000021</TxRef>
</TxId>
<POIId>
<Id>ASA00001</Id>
</POIId>
<TxTp>CRDP</TxTp>
<CardDataNtryMd>DFLE</CardDataNtryMd>
<TxRslt>
<RspnToAuthstn>
<Rspn>APPR</Rspn>
</RspnToAuthstn>
<AuthstnCd>000532</AuthstnCd>
</TxRslt>
</OrgnlTx>
<TxSucss>false</TxSucss>
<Rvsl>true</Rvsl>
<RcncltnId>1</RcncltnId>
<TxDtls>
<Ccy>EUR</Ccy>
<TtlAmt>99.12</TtlAmt>
</TxDtls>
</Tx>
</CxlAdvc>
</AccptrCxlAdvc>
</Document> |
NOTE: It is to be noted that if there is a declined on a CancellationRequest, no CancellationAdvice will be sent to the server. See the attached picture below for more information.
...
. Transaction log Search for Cancellation shall be enabled using |
Online Cancellation Settings
To enable Online Cancellation:
Set
'DF28' - Application Profile Settings(APS) for Cancellation [2, 8] = 1b (Cancellation shall be performed with Online Approval Request for transactions that are neither captured nor reconciled)
.Set
'DF28' - Application Profile Settings(APS) for Cancellation [2, 6] = 1b (Cancellation shall be performed with Online Approval Request for captured transactions)
.
Setting transaction log search for Online Cancellation
Transaction log search is configurable under the 'DF34' - Terminal Settings (Byte 3)
. Note that the setting will be applicable to all application profiles.
To force Transaction log Search for Online Cancellation, set 'DF34' - Terminal Settings [3, 7] = 1b
and 'DF34' - Terminal Settings [3, 6] = 0b
.
Otherwise, set 'DF34' - Terminal Settings [3, 7] = 0b
and 'DF34' - Terminal Settings [3, 6] = 1b
.
Note |
---|
Arkos API
See Amadis Developers' Guide page on Cancellation Service for more information.
Sequence Diagrams
Standalone POI
Original Transaction Date, Original Transaction Time and Original Transaction Time Zone will be added to the Arkos API. shall be mandatory for a cancellation.
Offline Cancellation Transaction Log Found
Info |
---|
Reference Data is mandatory for the Cancellation Service. |
Offline or Online Cancellation Transaction Log Not Found
Note |
---|
If the Transaction Log is not found, Arkos will return:
|
Online Cancellation
Note |
---|
For Online Cancellation without searching from log, a transaction amount must be provided by the MerchantApp. Transaction Amount (Mandatory) Note: For transaction with searching from logs, the amount is not validated. |
Connected POI
Offline Cancellation Transaction Log Found
Online Cancellation Transaction Log Found
Online Cancellation without searching from the log
It is to be noted that a slight modification was made to the flow of the latter (Online Cancellation without searching from the log) to help retrieve some Infos; such as AcquirerID, TerminalID, and etc. As it stands, this seems to be lackluster from Nexofast as they haven't thought out this solution properly. Upon implementing the flow they provided to us (nexoFAST 3.2), we ended up having some issues.
A new function was introduced as a solution to the problem.
The function setSelectedApplicationProfileNumberToDefaultFromServiceEntry
allows us to set a profile, initialized the application, and finally, construct valid messages.
Below is the modified diagram.