Skip to content

Configure the withdrawal webhook

POST
/withdraw/webhook

Creates or updates the configuration. The webhook is stored per user and applies to every withdrawal of that account.

NETTS sends a POST to your URL when a withdrawal reaches a terminal state, with the header X-Netts-Signature: base64(HMAC-SHA256(secret, body)). The signature is computed over canonical JSON: keys sorted, no spaces. Verify it against the raw request bytes; if you parse and re-serialise, reproduce the same canonical form.

Delivery: up to 3 attempts within 21 minutes of the order being created, with roughly 5 minutes between attempts. Any 2xx counts as success; anything else, including a timeout, is a failed attempt. After that delivery stops and the result must be collected by polling the status endpoint. Each order is delivered at most once successfully, but make your handler idempotent on orderId anyway.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Parameters

Header Parameters

X-Real-IP*

An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.

Type
string
Required
Example"203.0.113.10"
Format
"ipv4"

Request Body

application/json
JSON
{
  
"callback_url": "string",
  
"secret": "string",
  
"enabled": true
}

Responses

The configuration was saved.

Playground

Authorization
Headers
Body

Samples

Powered by VitePress OpenAPI