Attributes

AttributeTypeDescription
idstringThe unique, permanent, Clearpay-generated Order ID.
tokenstringCheckout token that was used to complete payment.
statusstringAn order status of "APPROVED" or "DECLINED".
createdstringThe UTC timestamp of when the payment was completed, in ISO 8601 format.
originalAmountMoneyTotal amount charged to the consumer for the order.
openToCaptureAmountMoneyRemaining amount that can be captured. Will always be zero for Immediate Payment Flow orders.
paymentStatestringCurrent state for capturing payments. Will be one of: "AUTH_APPROVED", "AUTH_DECLINED", "PARTIALLY_CAPTURED", "CAPTURED", "CAPTURE_DECLINED",
"VOIDED".
merchantReferencestringThe merchant's order id/reference that this payment corresponds to.
refundsRefundAn array of refunds.

Note: in response to a Capture Full Payment call, this array will always be empty, since refunds cannot occur until payment is captured.
orderDetailsOrder DetailsThe details of the order bound to the payment.
eventsPayment EventOne or more payment events that have occurred against the order.

Example Payment object

{
  "id": "12345678",
  "token": "004.5c61ac64153a9d0005985f7eltqdpjhbqu3veqikk95g7p3fhvcchfvtlsiobah3u4l5nln8gii9",
  "status": "APPROVED",
  "created": "2021-01-01T00:00:00.000Z",
  "originalAmount": {
    "amount": "100.00",
    "currency": "EUR"
  },
  "openToCaptureAmount": {
    "amount": "100.00",
    "currency": "EUR"
  },
  "paymentState": "AUTH_APPROVED",
  "merchantReference": "merchantOrderId-1234",
  "refunds": [],
  "events": [
    {
      "id": "1OUR16OTqL3DgJ3ELlwKowU9v6K",
      "created": "2021-01-01T00:00:00.000Z",
      "expires": "2021-01-01T00:00:00.000Z",
      "type": "AUTH_APPROVED",
      "amount": {
        "amount": "100.00",
        "currency": "EUR"
      }
    }
  ]
}