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
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
    • API Simulator
  • Models
    • Introduction
    • Contact Object
    • Consumer Object
    • Discount Object
    • Item Object
    • Money Object
    • Order Details Object
    • Payment Object
    • Refund Object
    • Shipping Courier Object
  • Service Status
    • GETPing
  • Configuration
    • GETGet Configuration
  • Orders
    • Introduction
    • GETGet Order
    • POSTCreate Order
  • Javascript afterpay.js
    • Information
    • Redirect Method
  • Payments
    • Introduction
    • POSTCapture Payment
    • PUTUpdate Shipping Courier
    • GETGet Payment By Order ID
    • GETGet Payment By Token
    • GETList Payment(s)
    • POSTCreate Refund
    • PUTUpdate Payment by Order ID
    • POSTReverse Payment By Token
  • Errors
    • Introduction
    • Get Errors
    • Put/Post Errors
  • Reference
LogoLogo
On this page
  • Attributes
  • Example Refund object
  • Australia
  • New Zealand
  • United States of America
Models

Refund object

Was this page helpful?
Previous

Shipping Courier Object

Next
Built with

Attributes

AttributeTypeDescription
idstringThe unique, Afterpay-generated refund ID.
refundedAtstringA UTC timestamp of the refund creation time, in ISO 8601 format.
merchantReferencestringThe merchant’s corresponding refund ID or reference.
amountMoneyThe refund amount.

Example Refund object

Australia

1{
2  "id": "67890123",
3  "refundedAt": "2019-01-01T00:00:00.000Z",
4  "merchantReference": "merchantRefundId-1234",
5  "amount": {  
6    "amount": "10.00",
7    "currency": "AUD"
8  }
9}

New Zealand

1{
2  "id": "67890123",
3  "refundedAt": "2019-01-01T00:00:00.000Z",
4  "merchantReference": "merchantRefundId-1234",
5  "amount": {  
6    "amount": "10.00",
7    "currency": "NZD"
8  }
9}

United States of America

1{
2  "id": "67890123",
3  "refundedAt": "2019-01-01T00:00:00.000Z",
4  "merchantReference": "merchantRefundId-1234",
5  "amount": {  
6    "amount": "10.00",
7    "currency": "USD"
8  }
9}