Webhooks

Payment free

A coupon discounted the whole amount of the payment and the order completed without a charge. A free order never sends PAYMENT_PAID.

Opt-in: delivered only to endpoints that selected this event, never to the others, and never for sandbox payments. A resend from the dashboard or by support repeats the exact body of the original delivery.

The HTTP body is this object exactly — there is no envelope and no type field. The event name is delivered in the X-Webhook-Event header.

postWebhookPAYMENT_FREE

Payload

idstring uuid required

Payment id.

txIdstring required

Payment transaction id.

status'FREE' required

Always FREE.

amount0 required

Always 0.

paidAtstring date-time required

When the order completed. GET /v1/payments/{paymentId} returns this time as completedAt, with paidAt: null.

endToEndIdunknown required

Response

Return a 2xx status to acknowledge receipt.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.