Gateway API
...
Authorisations
Refunds
5 min
a refund is initiated by the acceptor to return funds to a cardholder for a transaction that has already been settled refunds are used to reverse completed transactions where the payment has been cleared and processed through the gateway both full and partial refunds are supported multiple partial refunds can be processed against a single original transaction, provided the total refunded amount does not exceed the original transaction amount an acceptorauthorisationrequest with transaction transactiontype set to rfnd is used by an acceptor to request a refund this message must include a reference to the original settlted transaction using the originaltransaction property refunds can only be processed for transactions that have been successfully settled for transactions that have not yet been cleared, use an acceptorcancellationadvice message instead (see docid\ fylz zmbgtkhwagmlcip6 ) if the acceptor does not receive an acceptorauthorisationresponse , the acceptor should retry the request following standard retry procedures should an acquirer decline a refund request, the acceptor may need to contact the acquirer directly or refund the cardholder through alternative means request http parameters url /v1/caaa/authorisation request http verb post request message use iso200022 message definition acceptorauthorisationrequestv12 (message identifier caaa 001 001 12) it is recommended to use the iso 200022 dictionary to determine the complete structure of the message https //www iso20022 org/standardsrepository/type/acceptorauthorisationresponse12 please note the following additional requirements property transaction transactiontype must be set to value rfnd property securitytrailer of type contentinformationtype36 (child of acceptorauthorisationrequestv12 ) is mandatory property transaction originaltransaction (child of acceptorauthorisationrequestv12 ) 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 acceptorauthorisationresponsev12 message will be returned to inform the acceptor of the outcome of the operation the acceptorauthorisationresponsev12 (message identifier caaa 002 001 12) will be used it is recommended to use the iso 20022 dictionary to determine the complete structure of the message http //www iso20022 org/standardsrepository/type/acceptorauthorisationresponse12 please note that a securitytrailer of type contentinformationtype36 will always be included with the acceptorauthorisationresponse 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 please be aware that the value in the \<rcpttxid> field must be taken from the same field in the response body of the initial transaction for which the attempted refund is being completed for \<?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 001 001 13"> \<accptrauthstnreq> \<hdr> \<msgfctn>fauq\</msgfctn> \<prtcolvrsn>9 0\</prtcolvrsn> \<xchgid>954900253665113\</xchgid> \<credttm>2025 02 04t12 14 03 746z\</credttm> \<initgpty> \<id>test runner\</id> \<tp>opoi\</tp> \<issr>accp\</issr> \</initgpty> \<rcptpty> \<id>shift4\</id> \<tp>acqr\</tp> \</rcptpty> \</hdr> \<authstnreq> \<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> \<poi> \<id> \<id>poi 12345abcde\</id> \<issr>acqr\</issr> \</id> \<sysnm>poi01\</sysnm> \<cpblties> \<crdhldrvrfctncpblties>fcpn\</crdhldrvrfctncpblties> \<crdhldrvrfctncpblties>mnsg\</crdhldrvrfctncpblties> \<crdhldrvrfctncpblties>fepn\</crdhldrvrfctncpblties> \<crdhldrvrfctncpblties>npin\</crdhldrvrfctncpblties> \</cpblties> \<cmpnt> \<tp>term\</tp> \<id> \<prvdrid>miura\</prvdrid> \<id>m021 test01 v3 4\</id> \<srlnb>21100222\</srlnb> \</id> \</cmpnt> \</poi> \<card> \<prtctdcarddata> \<cntttp>evlp\</cntttp> \<envlpddata> \<rcpt> \<kek> \<kekid> \<keyid>sred key id\</keyid> \<keyvrsn>0\</keyvrsn> \<derivtnid>ijsxbqfa+gaedw==\</derivtnid> \</kekid> \<keyncrptnalgo> \<algo>dkp9\</algo> \</keyncrptnalgo> \</kek> \</rcpt> \<ncrptdcntt> \<cntttp>data\</cntttp> \<ncrptddata>ksi1uipr1axvvolkeeedbdku25eq+ktxzeqd/23aa7o=\</ncrptddata> \</ncrptdcntt> \</envlpddata> \</prtctdcarddata> \</card> \<crdhldr> \<authntcn> \<authntcnmtd>uknw\</authntcnmtd> \</authntcn> \</crdhldr> \</envt> \<cntxt> \<pmtcntxt> \<cardpres>true\</cardpres> \<crdhldrpres>true\</crdhldrpres> \<attndnccntxt>attd\</attndnccntxt> \<txchanl>mpos\</txchanl> \<attndntmsgcpbl>true\</attndntmsgcpbl> \<carddatantrymd>ectl\</carddatantrymd> \<fllbckind>nflb\</fllbckind> \<spprtdoptn>part\</spprtdoptn> \<spprtdoptn>pinq\</spprtdoptn> \</pmtcntxt> \<salecntxt> \<salercncltnid>088957484109\</salercncltnid> \</salecntxt> \</cntxt> \<tx> \<txcaptr>true\</txcaptr> \<txtp>rfnd\</txtp> \<mrchntctgycd>5411\</mrchntctgycd> \<salerefid>refund 71235291sbgw9l6o2r89\</salerefid> \<txid> \<txdttm>2025 02 04t12 14 03 757z\</txdttm> \<txref>088957484109\</txref> \</txid> \<orgnltx> \<salerefid>purchase 13487656spz35xeyhxsq\</salerefid> \<txid> \<txdttm>2025 02 04t11 44 13 224z\</txdttm> \<txref>132492614212\</txref> \</txid> \<poiid> \<id>21100222\</id> \</poiid> \<rcpttxid>01\ xzz02227b575a91e147oqyl7xunsnedb\</rcpttxid> \<txtp>crdp\</txtp> \<carddatantrymd>ectl\</carddatantrymd> \<txrslt> \<rspntoauthstn> \<rspn>appr\</rspn> \</rspntoauthstn> \<authstncd>414996\</authstncd> \</txrslt> \</orgnltx> \<rcncltnid>088957484109\</rcncltnid> \<txdtls> \<ccy>gbp\</ccy> \<ttlamt>10 00\</ttlamt> \<iccrltddata> ggizgiqhoaaaaaqqejufaaaegagaayucbjwbif8qagl4nwigaaaaaeaanwmgaaaaaaaanwkcaakfebibeiaaacaaaaaaaaaaaaaaaacfggiavp8ecdixmtawmjiynyyiwh3kdg9/+wkfjweanzmdigainzqdqgmanzubip82agaenzcek7ie8v80aqe=\</iccrltddata> \</txdtls> \</tx> \</authstnreq> \<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>vfgh9ht4nq9pbxyhdyj0uw==\</mac> \</authntcddata> \</sctytrlr> \</accptrauthstnreq> \</document> example response \<?xml version="1 0" encoding="utf 8"?> \<document xmlns\ none="urn\ iso\ std\ iso 20022\ tech\ xsd\ caaa 002 001 12" xmlns\ xsi="http //www w3 org/2001/xmlschema instance" xmlns="urn\ iso\ std\ iso 20022\ tech\ xsd\ caaa 002 001 12"> \<accptrauthstnrspn> \<hdr> \<msgfctn>faup\</msgfctn> \<prtcolvrsn>9 0\</prtcolvrsn> \<xchgid>954900253665113\</xchgid> \<credttm>2025 12 15t11 16 39 521z\</credttm> \<initgpty> \<id>test runner\</id> \<tp>opoi\</tp> \<issr>accp\</issr> \</initgpty> \<rcptpty> \<id>shift4\</id> \<tp>acqr\</tp> \</rcptpty> \</hdr> \<authstnrspn> \<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> \<poi> \<id> \<id>poi 12345abcde\</id> \<issr>acqr\</issr> \</id> \<sysnm>poi01\</sysnm> \<cpblties> \<crdhldrvrfctncpblties>fcpn\</crdhldrvrfctncpblties> \<crdhldrvrfctncpblties>mnsg\</crdhldrvrfctncpblties> \<crdhldrvrfctncpblties>fepn\</crdhldrvrfctncpblties> \<crdhldrvrfctncpblties>npin\</crdhldrvrfctncpblties> \</cpblties> \<cmpnt> \<tp>term\</tp> \<id> \<prvdrid>miura\</prvdrid> \<id>m021 test01 v3 4\</id> \<srlnb>21100222\</srlnb> \</id> \</cmpnt> \</poi> \<card> \<prtctdcarddata> \<cntttp>evlp\</cntttp> \<envlpddata> \<rcpt> \<kek> \<kekid> \<keyid>sred key id\</keyid> \<keyvrsn>0\</keyvrsn> \<derivtnid>ijsxbqfa+gaedw==\</derivtnid> \</kekid> \<keyncrptnalgo> \<algo>dkp9\</algo> \</keyncrptnalgo> \</kek> \</rcpt> \<ncrptdcntt> \<cntttp>data\</cntttp> \<ncrptddata>ksi1uipr1axvvolkeeedbdku25eq+ktxzeqd/23aa7o=\</ncrptddata> \</ncrptdcntt> \</envlpddata> \</prtctdcarddata> \</card> \<crdhldr> \<authntcn> \<authntcnmtd>uknw\</authntcnmtd> \</authntcn> \</crdhldr> \</envt> \<tx> \<salerefid>refund 71235291sbgw9l6o2r89\</salerefid> \<txid> \<txdttm>2025 02 04t12 14 03 757z\</txdttm> \<txref>088957484109\</txref> \</txid> \<rcpttxid>05\ xzz02c783a9b4e87a1b3ax2wscta5cqf\</rcpttxid> \<rcncltnid>088957484109\</rcncltnid> \<txdtls> \<ccy>gbp\</ccy> \<ttlamt>10 00\</ttlamt> \<reqdamt>10 00\</reqdamt> \<authrsdamt>10 00\</authrsdamt> \<iccrltddata>igiwmikgmdcxndg2\</iccrltddata> \</txdtls> \</tx> \<txrspn> \<authstnrslt> \<authstnntty> \<tp>acqr\</tp> \</authstnntty> \<rspntoauthstn> \<rspn>appr\</rspn> \<rspnrsn>approved or completed successfully\</rspnrsn> \</rspntoauthstn> \<authstncd>071486\</authstncd> \<cmpltnreqrd>false\</cmpltnreqrd> \</authstnrslt> \</txrspn> \</authstnrspn> \<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>4bzumx0lt0sewyfgphypjw==\</mac> \</authntcddata> \</sctytrlr> \</accptrauthstnrspn> \</document>
