Cancellations
Cancellation is initiated by Acceptor to cancel a payment which was successfully completed. A cancellation is a user requested reversal. A cancellation cannot be revoked.
It is at present only possible refund the full amount of a transaction.
An AcceptorCancellationAdvice is used by an Acceptor to inform the Acquirer that a cancellation is required.
An AcceptorCancellationAdvice can only be used if the Acceptor is aware that the transaction was not yet cleared. In a future version AcceptorCancellationRequest messages will be supported, allowing the Acceptor to check if it is currently possible to cancel the transaction.
If the Acceptor does not receive an AcceptorCancellationAdviceResponse, the Acceptor has to resend an AcceptorCancellationAdvice until the Acceptor receives the corresponding response from the Acquirer.
Should an Acquirer decline an AcceptorCancellationAdvice, an Acceptor always has the possibility to refund the cardholder in cash or with a refund transaction.
Request HTTP Parameters
URL: /v1/caaa/cancellation-advice
HTTP verb: POST
Request Message
Use ISO20022 message definition AcceptorCancellationAdviceV12 (message identifier: caaa.007.001.12).
It is recommended to use the ISO 20022 Dictionary to determine the complete structure of the message: https://www.iso20022.org/standardsrepository/type/AcceptorCancellationAdviceV12
Please note the following additional requirements:
- Property SecurityTrailer of type ContentInformationType36 (child of AcceptorCancellationAdviceV12) is mandatory.
- Property OriginalTransaction (child of AcceptorCancellationAdviceV12) is mandatory.
- Other mandatory properties of OriginalTransaction are: TransactionType, SaleReferenceIdentification, and POIIdentification.
Response Message
If the request could not be successfully processed, an AcceptorRejection message will be returned.
Otherwise, an AcceptorCancellationAdviceResponse message will be returned to inform the Acceptor of the outcome of the operation.
The AcceptorCancellationAdviceResponseV11 (message identifier: caaa.008.001.11) will be used.
It is recommended to use the ISO 20022 Dictionary to determine the complete structure of the message: https://www.iso20022.org/standardsrepository/type/AcceptorCancellationAdviceResponseV11
Please note that a SecurityTrailer of type ContentInformationType36 will always be included with the AcceptorCancellationAdviceResponse to allow the Acceptor to verify that the response is legitimate.
Examples
The message provided below are formatted for readability. When sending requests to the gateway, the request body should be compacted by removing all non-significant whitespace characters.
Example request
<?xml version="1.0" encoding="UTF-8"?>
<Document
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.007.001.12">
<AccptrCxlAdvc>
<Hdr>
<MsgFctn>CCAV</MsgFctn>
<PrtcolVrsn>9.0</PrtcolVrsn>
<XchgId>389520543139205</XchgId>
<CreDtTm>2025-02-10T09:49:41.718Z</CreDtTm>
<InitgPty>
<Id>TEST_RUNNER</Id>
<Tp>OPOI</Tp>
<Issr>ACCP</Issr>
</InitgPty>
</Hdr>
<CxlAdvc>
<Envt>
<Mrchnt>
<Id>
<Id>EPASMER001</Id>
</Id>
<CmonNm>EPASOrg Merchant 1</CmonNm>
<LctnCtgy>FIXD</LctnCtgy>
<LctnAndCtct>
<PstlAdr>
<TwnNm>Paris</TwnNm>
<CtryCd>FR</CtryCd>
</PstlAdr>
</LctnAndCtct>
</Mrchnt>
</Envt>
<Cntxt>
<PmtCntxt>
<CardPres>true</CardPres>
<CrdhldrPres>true</CrdhldrPres>
<AttndncCntxt>ATTD</AttndncCntxt>
<TxChanl>MPOS</TxChanl>
<AttndntMsgCpbl>true</AttndntMsgCpbl>
<CardDataNtryMd>MGST</CardDataNtryMd>
<FllbckInd>FFLB</FllbckInd>
<SpprtdOptn>PINQ</SpprtdOptn>
</PmtCntxt>
<SaleCntxt>
<SaleRcncltnId>395142017661</SaleRcncltnId>
</SaleCntxt>
</Cntxt>
<Tx>
<MrchntCtgyCd>5411</MrchntCtgyCd>
<TxId>
<TxDtTm>2025-02-10T09:49:41.738Z</TxDtTm>
<TxRef>395142017661</TxRef>
</TxId>
<OrgnlTx>
<SaleRefId>purchase_809615971Y6MDQM9NDM5</SaleRefId>
<TxId>
<TxDtTm>2025-02-10T10:49:41.738Z</TxDtTm>
<TxRef>395142017662</TxRef>
</TxId>
<POIId>
<Id>21100222</Id>
<Tp>OPOI</Tp>
<Issr>MERC</Issr>
</POIId>
<TxTp>CRDP</TxTp>
<TxRslt>
<AuthstnNtty>
<Id>SHIFT4</Id>
<Tp>OPOI</Tp>
<Issr>MERC</Issr>
<Ctry>UK</Ctry>
</AuthstnNtty>
<RspnToAuthstn>
<Rspn>APPR</Rspn>
<RspnRsn>Approved</RspnRsn>
<AddtlRspnInf>{{AddtlRspnInf}}</AddtlRspnInf>
</RspnToAuthstn>
<AuthstnCd>123456</AuthstnCd>
</TxRslt>
</OrgnlTx>
<TxSucss>true</TxSucss>
<Rvsl>false</Rvsl>
<TxDtls>
<TtlAmt Ccy="GBP">10.00</TtlAmt>
</TxDtls>
</Tx>
</CxlAdvc>
<SctyTrlr>
<CnttTp>AUTH</CnttTp>
<AuthntcdData>
<Rcpt>
<KeyIdr>
<KeyId>SpecV1TestKey</KeyId>
<KeyVrsn>1</KeyVrsn>
</KeyIdr>
</Rcpt>
<MACAlgo>
<Algo>CCA3</Algo>
</MACAlgo>
<NcpsltdCntt>
<CnttTp>DATA</CnttTp>
</NcpsltdCntt>
<MAC>iNShiL31RRZmmeqkYqsIYg==</MAC>
</AuthntcdData>
</SctyTrlr>
</AccptrCxlAdvc>
</Document>Example response
<?xml version="1.0" encoding="UTF-8"?>
<Document
xmlns:None="urn:iso:std:iso:20022:tech:xsd:caaa.008.001.11"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="urn:iso:std:iso:20022:tech:xsd:caaa.008.001.11">
<AccptrCxlAdvcRspn>
<Hdr>
<MsgFctn>CCAK</MsgFctn>
<PrtcolVrsn>9.0</PrtcolVrsn>
<XchgId>389520543139205</XchgId>
<CreDtTm>2025-09-02T11:47:01.469Z</CreDtTm>
<InitgPty>
<Id>TEST_RUNNER</Id>
<Tp>OPOI</Tp>
<Issr>ACCP</Issr>
</InitgPty>
</Hdr>
<CxlAdvcRspn>
<Envt>
<Mrchnt>
<Id>
<Id>EPASMER001</Id>
</Id>
<CmonNm>EPASOrg Merchant 1</CmonNm>
<LctnCtgy>FIXD</LctnCtgy>
<LctnAndCtct>
<PstlAdr>
<TwnNm>Paris</TwnNm>
<CtryCd>FR</CtryCd>
</PstlAdr>
</LctnAndCtct>
</Mrchnt>
</Envt>
<Tx>
<TxId>
<TxDtTm>2025-02-10T09:49:41.738Z</TxDtTm>
<TxRef>395142017661</TxRef>
</TxId>
<Rspn>APPR</Rspn>
</Tx>
</CxlAdvcRspn>
<SctyTrlr>
<CnttTp>AUTH</CnttTp>
<AuthntcdData>
<Vrsn>0</Vrsn>
<Rcpt>
<KeyIdr>
<KeyId>SpecV1TestKey</KeyId>
<KeyVrsn>1</KeyVrsn>
</KeyIdr>
</Rcpt>
<MACAlgo>
<Algo>CCA3</Algo>
</MACAlgo>
<NcpsltdCntt>
<CnttTp>DATA</CnttTp>
</NcpsltdCntt>
<MAC>gJLSOH/eBsGQizWzwykaJw==</MAC>
</AuthntcdData>
</SctyTrlr>
</AccptrCxlAdvcRspn>
</Document>