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.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • Contact Object
      • Consumer Object
      • Discount Object
      • Item Object
      • Money Object
      • Order Details Object
      • Payment Object
      • Payment Event Object
      • Refund Object
      • Shipping Courier Object
LogoLogo
On this page
  • Attributes
  • Example Refund object
ReferenceData Models

Refund object

Was this page helpful?
Previous

Shipping Courier Object

Next
Built with

Attributes

AttributeTypeDescription
requestIdstringA unique request ID, required (in conjunction with merchantReference) for safe retries. We recommend that merchants generate a UUID for each unique refund. Max character length = 64.
amountMoney (required)The refund amount.
merchantReferencestringThe merchant’s corresponding refund ID or reference, required (in conjunction with requestId) for safe retries. Max character length = 64.
refundIdstringThe unique, Afterpay-generated refund ID.
refundedAtstringA UTC timestamp of the refund creation time, in ISO 8601 format.
refundMerchantReferencestringA unique reference for the individual refund event. If provided, the value appears in the daily settlement file as “Payment Event ID”. In most cases, this holds the same value as the merchantReference. Max character length = 128.

Example Refund object

1{
2  "requestId" : "956946da-4863-4797-aa7c-540050faf922",
3  "amount" : {
4    "amount" : "10.00",
5    "currency" : "USD"
6  },
7  "merchantReference" : "merchantRefundId-1234",
8  "refundId" : "67890123",
9  "refundedAt" : "2024-01-01T00:00:00.000Z",
10  "refundMerchantReference" : "merchantRefundId-1234"
11}