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

Payment Event

Example
1{
2  "id": "event-123",
3  "type": "CAPTURE",
4  "created": "2023-08-24T14:15:22Z",
5  "amount": {
6    "amount": "100.00",
7    "currency": "AUD"
8  }
9}
Was this page helpful?
Previous

Payment

Next
Built with

Response

payment_eventobjectRequired
Each payment event has a unique ID, creation timestamp, and type (e.g., "AUTH_APPROVED", "AUTH_DECLINED"). For "AUTH_APPROVED" events, an expiration timestamp is provided. The "payment event merchant reference" field, which can be used for payment capture events.