settle.subscribe
Register a webhook callback for settlement completion events. Your endpoint receives a POST with X-DPX-Signature: sha256= over the raw JSON body whenever a settlement completes. Returns a subscriptionId and webhookSecret — store the secret immediately, it is returned once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | HTTPS endpoint to receive settlement.completed events | |
| events | No | Event types (default: ["settlement.completed"]) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| events | No | ||
| webhookSecret | No | HMAC secret — returned once, store immediately | |
| subscriptionId | No |