Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.noxpay.io/llms.txt

Use this file to discover all available pages before exploring further.

How webhooks work

Noxpay sends a webhook to your configured URL at every stage transition of a transaction. The payload is identical to what you would receive from the corresponding GET endpoint for that resource — there is no separate webhook format to implement. Your webhook handler can reuse the same parsing logic as your polling or retrieval code. Parse the template field to know which resource type the payload represents, then handle status and substatus as you would in a GET response. See the Transaction Object for the full payload shape, and the Statuses reference for all possible status / substatus combinations per resource.

Configuring a webhook URL

Webhooks are set per transaction at creation time. There is no global webhook URL — each transaction carries its own.
ResourceWhere to set it
Crossramp Checkoutwebhook field in the POST /v2/crossramp_checkout request body
Onramp / Onramp Instantwebhook field when creating the transaction via API
Offramp / Offramp Instantwebhook field when creating the transaction via API
If no webhook URL is provided at creation, no notifications are sent for that transaction.

Chargebacks

When a chargeback is raised against a completed payment, Noxpay sends a webhook notification to the URL registered on the original transaction that generated the chargeback. No separate webhook configuration is needed — as long as the originating payment had a webhook URL, chargeback events will be delivered there automatically.

Reliability

Webhook delivery is retried on failure. If your endpoint does not return a 2xx response, Noxpay will retry the delivery. Make sure your handler is idempotent — the same payload may be delivered more than once.