Create Webhook EndPoint
Create Webhook EndPoint
POST {{Environment_URL}}/v1/payments/webhook/endpoints
Registers a new webhook URL for a specific scope.
It is possible to register more than one URL for each scope.
Permited scopes
EXTERNAL_DEPOSIT
Scope for receiving external deposit notifications
String
PAYOUT
Scope for receiving payout notifications
String
PAYMENT
Scope for receiving payin notifications
String
FUNDING
Scope for receiving funding notifications (account deposits)
String
MED
Scope for receiving med notifications
String
ACCOUNT
Scope for receiving Accounts and Sub-account notifications
String
Headers
Authorization
Bearer <token>
Body
scope
Scope desired to create a webhook
String
yes
FUNDING
url
URL from webhook
String
yes
http://adrian.biz
secret
Security secret, to use signed webhooks
String
no
<token>
token
Security token
String
no
<token>
Secret:
When creating a webhook, you may include an optional secret field in the request.v
This secret will be required for the verification process described in the "Signed Webhooks" section.
Token:
When creating a webhook, you may include an optional token field in the request.
This token will be attached to every webhook delivery we send. You can use it on your side to add an extra layer of validation, confirming that the request truly originated from our system.
Although verifying the webhook signature (via x-webhook-signature) is the primary security mechanism, validating the token provides an additional safeguard. This step is optional but recommended if you want stronger protection for your webhook endpoints.
Request Body
Response