Skip to main content

Headers

X-Signature
string

t=TIMESTAMP,v1=SIGNATURE, where SIGNATURE is a hex HMAC-SHA256 of the timestamp, a full stop and the raw request body, keyed by the whole signing_secret of the endpoint it's sent to, or on a merchant's Default webhook by that webhook's own whsec_ secret. Absent on an endpoint registered with is_signed: false.

X-Timestamp
string
required

The t value, in Unix seconds.

X-Client-Id
string
required

On a transaction's event, the client_id of the merchant the transaction is for. On a merchant's event, the partner's.

Body

application/json
result
object
required
entities
object
required

Nothing can be included here.

not_included
object[]
required
id
string
required
deprecated

The earlier format's ID, which every event of one transaction shares, so it isn't result.id. Integrations built on the earlier event format read it, and every event carries it. New integrations read result.

object
string
required
deprecated

Always event. Integrations built on the earlier event format read it, and every event carries it. New integrations read result.

Allowed value: "event"
created
integer
required
deprecated

result.created_at in Unix seconds. Integrations built on the earlier event format read it, and every event carries it. New integrations read result.

type
enum<string>
required
deprecated

The earlier format's event type. Integrations built on the earlier event format read it, and every event carries it. New integrations read result.

Available options:
quidkey.payment_request.pending,
quidkey.payment_request.succeeded,
quidkey.payment_request.failed,
quidkey.payment_request.canceled,
quidkey.payment_request.reversed
data
object
required
deprecated

What the event is about. Integrations built on the earlier event format read it, and every event carries it. New integrations read result.

Response

200

Any 2xx status acknowledges the event. Answer quickly, and do the work afterwards.