Attributes
Attribute | Type | Description |
---|---|---|
| string | The unique, permanent, Clearpay-generated Order ID. |
| string | Checkout token that was used to complete payment. |
| string | An order status of "APPROVED" or "DECLINED". |
| string | The UTC timestamp of when the payment was completed, in ISO 8601 format. |
| Total amount charged to the consumer for the order. | |
| Remaining amount that can be captured. Will always be zero for Immediate Payment Flow orders. | |
| string | Current state for capturing payments. Will be one of: "AUTH_APPROVED", "AUTH_DECLINED", "PARTIALLY_CAPTURED", "CAPTURED", "CAPTURE_DECLINED", |
| string | The merchant's order id/reference that this payment corresponds to. |
| Refund[] | An array of refunds. |
| The details of the order bound to the payment. | |
| One or more payment events that have occurred against the order. |
{
"id" : "12345678",
"token" : "ltqdpjhbqu3veqikk95g7p3fhvcchfvtlsiobah3u4l5nln8gii9",
"status" : "APPROVED",
"created" : "2019-01-01T00:00:00.000Z",
"originalAmount" : {
"amount" : "100.00",
"currency" : "GBP"
},
"openToCaptureAmount" : {
"amount" : "100.00",
"currency" : "GBP"
},
"paymentState" : "AUTH_APPROVED",
"merchantReference" : "merchantOrderId-1234",
"refunds" : [
...
],
"orderDetails" : {
...
},
"events" : [ {
"id" : "1OUR16OTqL3DgJ3ELlwKowU9v6K",
"created" : "2019-01-01T00:00:00.000Z",
"expires" : "2019-01-01T00:00:00.000Z",
"type" : "AUTH_APPROVED",
"amount" : {
"amount" : "100.00",
"currency" : "GBP"
}
}, ... ]
}