Skip to navigation
Models

Refund object

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

{
  "id": "67890123",
  "refundedAt": "2019-01-01T00:00:00.000Z",
  "merchantReference": "merchantRefundId-1234",
  "amount": {  
    "amount": "10.00",
    "currency": "AUD"
  }
}

New Zealand

{
  "id": "67890123",
  "refundedAt": "2019-01-01T00:00:00.000Z",
  "merchantReference": "merchantRefundId-1234",
  "amount": {  
    "amount": "10.00",
    "currency": "NZD"
  }
}

United States of America

{
  "id": "67890123",
  "refundedAt": "2019-01-01T00:00:00.000Z",
  "merchantReference": "merchantRefundId-1234",
  "amount": {  
    "amount": "10.00",
    "currency": "USD"
  }
}