{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Refunds API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"refunds-api","__idx":0},"children":["Refunds API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Refund any integrated EFTPOS transaction back to the customer's original payment method, without requiring the card to be re-presented."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-is-it","__idx":1},"children":["What is it?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Refunds API processes card-not-present refunds for integrated EFTPOS transactions. Every refund is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["referenced refund"]}," — it must reference the original transaction via a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," — so funds always return to the same card or account used for the original payment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":2},"children":["Requirements"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Requirement"},"children":["Requirement"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business operations (refunds)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None — refunds are a single synchronous request/response call"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup steps"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Standard JWT authentication — you'll also need the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," of the original transaction, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/business-operations/refunds/finding-a-transaction-reference"},"children":["Finding a transaction reference"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Limitations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only POS-integrated, AUD-settled transactions from 28 March 2025 onward are eligible — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#conditions-and-limitations"},"children":["Conditions and limitations below"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#api-reference"},"children":["Jump to API reference"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-features","__idx":3},"children":["Key features"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Funds return to the original payment method"]},": Refunds are always credited back to the same card or account used for the original payment, not as cash or to another card."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Card-not-present refunds"]},": Customers don't need to present their card again at the terminal."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Partial refunds"]},": Supports multiple partial refunds, provided the total refunded amount doesn't exceed the original transaction amount."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Simpler reconciliation"]},": Every refund references the original transaction, giving you a complete audit trail across full and partial refunds."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fraud protection"]},": Tying refunds to the original payment method reduces risks such as receipt fraud, stolen merchandise returns, or cross-retailer return fraud."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":4},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must know the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originChannel"]}," - the sales channel where the original transaction was processed."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must pass the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," generated for that transaction — how you find it depends on the channel, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/business-operations/refunds/finding-a-transaction-reference"},"children":["Finding a transaction reference"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Some POS providers don't guarantee globally unique transaction references — in that case, also include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rrn"]}," (Retrieval Reference Number) with the refund request to ensure accurate matching."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-concepts","__idx":5},"children":["Key concepts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transaction reference"]}," — the identifier of the original transaction, generated by the POS system or online system. Where to find it depends on the channel the payment was made through."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RRN"]}," — the Retrieval Reference Number of the original transaction. Required alongside the transaction reference when the reference alone isn't guaranteed unique."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-works","__idx":6},"children":["How it works"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identify the original transaction"]}," — Find the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionReference"]}," (and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rrn"]},", if needed) using ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/business-operations/refunds/finding-a-transaction-reference"},"children":["this guide"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create the refund"]}," — Call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/refunds/1.0/other/search-and-refund"},"children":["Create a refund"]}," with the transaction reference, origin channel, and amount to refund."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check the remaining balance"]}," — The response includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amountAvailableForRefund"]},", so you can validate a follow-up partial refund before making it."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"conditions-and-limitations","__idx":7},"children":["Conditions and limitations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Effective date"]},": Refunds are available only for transactions made on or after 28 March 2025."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported transactions"]},": Only POS integrated transactions are eligible. Online/eCommerce transactions are not currently supported."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Currency support"]},": Only transactions settled in AUD are supported at this time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pre-authorisations not supported"]},": Refunds cannot be processed against pre-authorised transactions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unsupported payment methods"]},": Refunds for Alipay transactions are not supported."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required identifier"]},": You must pass the transaction reference generated by the POS at the time of sale."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Uniqueness considerations"]},": Some POS providers don't guarantee globally unique transaction references. In these cases, also include the RRN with the refund request to ensure accurate matching."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"getting-started","__idx":8},"children":["Getting started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/business-operations/refunds/testing"},"children":["Testing"]}," covers simulating refund responses — successes, declines, and edge cases — in the sandbox before you process a live refund."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-reference","__idx":9},"children":["API reference"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/refunds/1.0/other/search-and-refund"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /refunds/search-and-refund"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a refund"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full request and response schemas, including error responses, are in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/refunds/1.0/other/search-and-refund"},"children":["API Explorer"]},"."]}]},"headings":[{"value":"Refunds API","id":"refunds-api","depth":1},{"value":"What is it?","id":"what-is-it","depth":2},{"value":"Requirements","id":"requirements","depth":2},{"value":"Key features","id":"key-features","depth":2},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Key concepts","id":"key-concepts","depth":2},{"value":"How it works","id":"how-it-works","depth":2},{"value":"Conditions and limitations","id":"conditions-and-limitations","depth":2},{"value":"Getting started","id":"getting-started","depth":2},{"value":"API reference","id":"api-reference","depth":2}],"frontmatter":{"seo":{"title":"Refunds API"}},"lastModified":"2026-09-10T06:51:58.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/business-operations/refunds/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}