Online APIModels

Payment object

Attributes

AttributeTypeDescription
idstringThe unique, permanent, Clearpay-generated Order ID.
tokenstringOrder token that was used to complete payment.
statusstringAn 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”.
createdstringThe UTC timestamp of when the payment was completed, in ISO 8601 format.
totalAmountMoneyTotal amount charged to the consumer for the order.
merchantReferencestringThe merchant’s order id/reference that this payment corresponds to.
refundsRefund[]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.
orderDetailsOrder DetailsThe order bound to the payment.
eventsarrayThis array is an obsolete field; it will always be empty.

Example Payment object

UK
1{
2  "id": "12345678",
3  "token": "ltqdpjhbqu3veqikk95g7p3fhvcchfvtlsiobah3u4l5nln8gii9",
4  "status": "APPROVED",
5  "created": "2019-01-01T00:00:00.000Z",
6  "totalAmount": {
7    "amount": "29.99",
8    "currency": "GBP"
9  },
10  "merchantReference": "merchantOrderId-1234",
11  "refunds": [
12    ...
13  ],
14  "orderDetails": {
15    ...
16  },
17  "events": []
18}