order - Clink Documentation

{ "id": "evt_xxxxx", "object": "event", "created": 1750062041000, "type": "order.succeeded", "data": { "object": { "orderId": "ord_xxxxx", "type": "onetime", "merchantReferenceId": "pay_ref_123", "customerId": "cus_xxxxx", "customerEmail": "customer@example.com", "createTime": 1750062041000, "amountSubtotal": 19.99, "amountTotal": 19.99, "paymentCurrency": "USD", "originalCurrency": "USD", "status": "success", "paymentTime": 1750062041000, "paymentMethod": { "paymentMethodType": "CARD", "paymentInstrumentId": "pi_xxxxx", "cardScheme": "Visa", "cardLastFour": "4242", "issuerRegion": "US", "issuerBank": "Chase Bank" }, "metadata": { "orderNo": "ORDER-10001" } } } }

{ "object": "event", "type": "account.created", "data": { "customerEmail": "customer@example.com", "webSite": "https://example.com", "userId": "usr_xxxxx", "amount": 19.99, "currency": "USD" } }

Headers

X-Clink-Timestamp

string

required

Timestamp sent by Clink for webhook signature verification.

X-Clink-Signature

string

required

Hex-encoded HMAC-SHA256 signature generated with the webhook signing secret over the string ${X-Clink-Timestamp}.${rawRequestBody}. Use the raw request body bytes/string exactly as received; do not parse and re-serialize the JSON before verifying.

X-Clink-SignType

enum<string>

required

Signature algorithm used to generate X-Clink-Signature. The current value is SHA256.

Available options:

SHA256

Body

application/json

Order event payload in json

string

Unique identifier for the event

type

enum<string>

Type of event that occurred

Available options:

order.created,

order.next_action,

order.succeeded,

order.failed

object

string

Type of this json payload, 'event' if this is an event

Example:

"event"

created

integer<int64>

Unix timestamp in milliseconds when the event occurred

data

object

Show child attributes

Response

200 - application/json

HTTP 200 after successful handling; order.succeeded includes merchant account JSON response; other order event types may return empty HTTP 200

object

enum<string>

required

Available options:

event

Example:

"event"

type

enum<string>

required

Merchant account response type. account.created indicates that a new merchant account was created successfully. account.reloaded indicates that an existing merchant account matched and the merchant confirms that it received the successful-payment notification.

Available options:

account.created,

account.reloaded

data

object

required

Show child attributes