Skip to main content
POST
/
v1
/
webhooks
Create a webhook subscription
curl --request POST \
  --url https://api.antonpayments.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://api.example.com/webhooks/anton",
  "events": [
    "payout.created"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "merchant_id": "<string>",
    "url": "<string>",
    "events": [
      "payout.created"
    ],
    "status": "active",
    "version": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_* (production) or ak_test_* (sandbox).

Body

application/json
url
string<uri>
required

HTTPS endpoint URL.

Example:

"https://api.example.com/webhooks/anton"

events
enum<string>[]
required
Minimum array length: 1
Available options:
payout.created,
payout.approved,
payout.processing,
payout.sent,
payout.completed,
payout.failed,
payout.cancelled,
payout.returned,
beneficiary.created,
beneficiary.updated,
beneficiary.deleted,
batch.uploaded,
batch.completed,
batch.failed,
balance.low,
funding.credit,
screening.hit,
fx.quote.created,
fx.exchange.created,
fx.exchange.completed,
fx.exchange.failed,
test

Response

Subscription created with signing secret.

data
object
required