For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference
    • Introduction
      • Capture Payment
      • Consumer
      • Consumer Offers
      • Contact
      • Create Refund
      • Discount
      • Interval
      • Item
      • Money
      • Offer
      • Offers Request
      • Offers Response
      • Order Details
      • Payment Event
      • Payment
      • Payment (Auth)
      • Payment Schedule
      • Refund
      • Shipping Courier
LogoLogo
ReferenceModels

Refund

Example
1{
2  "requestId": "49efce77-4bf2-4e41-86e8-c2b92f493c2a",
3  "amount": {
4    "amount": "10.00",
5    "currency": "AUD"
6  },
7  "merchantReference": "merchantRefundId-1234",
8  "refundId": "67890123",
9  "refundedAt": "2023-01-01T00:00:00.000Z",
10  "refundMerchantReference": "merchantRefundId-1234"
11}
Was this page helpful?
Previous

Shipping Courier

Next
Built with

Response

refundobjectRequired
To guarantee safe retries, the merchant should offer their refund ID or reference, aligning with their internal records Unique values for the `requestID` and `merchantReference` are required to guarantee safe retries. It is recommended that the merchant generates a UUID for each unique refund request. The `refundMerchantReference` is a unique reference that when provided, will appear in the daily settlement file as "Payment Event Id". In most cases, this would hold the same value as the `merchantReference`.