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 Payment Event object
ReferenceData Models

Payment Event object

Was this page helpful?
Previous

Refund Object

Next
Built with

Attributes

AttributeTypeDescription
idstringThe unique, Afterpay-generated event ID.
createdstringA UTC timestamp of the event creation time, in ISO 8601 format.
expiresstringA UTC timestamp of the “AUTH_APPROVED” event expiration time, in ISO 8601 format. Null for other event types.
typestringThe event type. Will be one of: “AUTH_APPROVED”, “AUTH_DECLINED”, “CAPTURED”, “CAPTURE_DECLINED”, “VOIDED”, “EXPIRED”.
amountMoneyThe amount associated with the event.
paymentEventMerchantReferencestringA unique reference for an individual payment capture event. If provided on Capture Full Payment, the value will appear in the daily settlement file as “Payment Event ID”.

Example Payment Event object

1{
2  "id" : "1OUR16OTqL3DgJ3ELlwKowU9v6K",
3  "created" : "2024-01-01T00:00:00.000Z",
4  "expires" : "2024-01-01T00:00:00.000Z",
5  "type" : "AUTH_APPROVED",
6  "amount" : {
7    "amount" : "100.00",
8    "currency" : "USD"
9  },
10  "paymentEventMerchantReference" : null
11}