Skip to main content
WEBHOOK

Headers

X-Meridian-Resource-Type
string
required

Resource type carried by the webhook.

Allowed value: "payment_link_transaction"
X-Meridian-Event-Type
enum<string>
required

The payment link transaction event that occurred.

Available options:
payment_link_transaction_created,
payment_link_transaction_status_updated,
payment_link_transaction_succeeded,
payment_link_transaction_failed
X-Meridian-Api-Key
string

API key issued by Meridian, sent so you can authenticate the webhook. Sent only when your webhook endpoint is configured for Meridian HMAC signing.

X-Meridian-Timestamp
string

Time the webhook was generated, in milliseconds since the Unix epoch. Sent only when your webhook endpoint is configured for Meridian HMAC signing.

X-Meridian-Signature
string

HMAC SHA-256 signature of the webhook request, for verifying that Meridian sent it. Sent only when your webhook endpoint is configured for Meridian HMAC signing.

Body

application/json

The payment link and the transaction the event relates to.

Webhook payload sent when a payment link transaction is created or changes status. The body has no envelope. The event name is in the X-Meridian-Event-Type header.

The payment link the transaction belongs to, as it was when Meridian sent the webhook. The link and the transaction are updated separately, so the link's status can lag the transaction. Use transaction.status as the source of truth for the payment outcome.

transaction
PaymentLinkTransactionNotification · object
required

The transaction and the status change that triggered the event.

Response

200

Return any 2xx status to acknowledge the webhook. Any other status causes Meridian to retry.