Attributes

Attribute

Type

Description

id

string

The unique, Clearpay-generated event ID.

created

string

A UTC timestamp of the event creation time, in ISO 8601 format.

expires

string

A UTC timestamp of the "AUTH_APPROVED" event expiration time, in ISO 8601 format. Null for other event types.

type

string

The event type. Will be one of: "AUTH_APPROVED", "AUTH_DECLINED", "CAPTURED", "CAPTURE_DECLINED", "VOIDED", "EXPIRED".

amount

Money

The amount associated with the event.

paymentEventMerchantReference

string

A unique reference for an individual payment capture event. If provided on Capture Payment, the value will appear in the daily settlement file as "Payment Event ID".

Example Payment Event object

{
  "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"
  },
  "paymentEventMerchantReference" : null
}