Attributes
Attribute | Type | Description |
---|---|---|
id | string | The unique, permanent, Clearpay-generated Order ID. |
token | string | Order token that was used to complete payment. |
status | string | An order status of "APPROVED" or "DECLINED". Note: in response to a Capture Payment call, an object in this format will only be returned if the status is "APPROVED". |
created | string | The UTC timestamp of when the payment was completed, in ISO 8601 format. |
totalAmount | Money | Total amount charged to the consumer for the order. |
merchantReference | string | The merchant's order id/reference that this payment corresponds to. |
refunds | Refund[] | An array of refunds. Note: in response to a Capture Payment call, this array will always be empty, since refunds cannot occur before payment is captured. |
orderDetails | Order Details | The order bound to the payment. |
events | array | This array is an obsolete field; it will always be empty. |
{
"id": "12345678",
"token": "ltqdpjhbqu3veqikk95g7p3fhvcchfvtlsiobah3u4l5nln8gii9",
"status": "APPROVED",
"created": "2019-01-01T00:00:00.000Z",
"totalAmount": {
"amount": "29.99",
"currency": "GBP"
},
"merchantReference": "merchantOrderId-1234",
"refunds": [
...
],
"orderDetails": {
...
},
"events": []
}