Cancellations

5 min

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> 	 \<rcptpty> 	 \<id>shift4\</id> 	 \<tp>acqr\</tp> 	 \</rcptpty> 	 \</hdr> 	 \<cxladvc> 	 \<envt> 	 \<acqrr> 	 \<id> 	 \<id>9287351\</id> 	 \<tp>acqr\</tp> 	 \</id> 	 \<paramsvrsn>2020 06 24 17 27 17\</paramsvrsn> 	 \</acqrr> 	 \<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> 	 \<rcptpty> 	 \<id>shift4\</id> 	 \<tp>acqr\</tp> 	 \</rcptpty> 	 \</hdr> 	 \<cxladvcrspn> 	 \<envt> 	 \<acqrr> 	 \<id> 	 \<id>9287351\</id> 	 \<tp>acqr\</tp> 	 \</id> 	 \<paramsvrsn>2020 06 24 17 27 17\</paramsvrsn> 	 \</acqrr> 	 \<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>