POST
/
api
/
webhook
/
merchant
  curl --request POST \
  --url https://api.atoa.me/api/webhook/merchant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://api/endpoint",
  "event": "PAYMENTS_STATUS"
}'
{
  "webhookId": "4a124f25-fe8d-47a0-92c8-16d94cbfe24c",
  "url": "https://example.com",
  "event": "PAYMENTS_STATUS"
}

Register a webhook endpoint for a specific event type. Each event type requires a separate subscription. See the Webhook introduction for event types, authentication, and signature verification.

  • Default - No additional auth

  • OAuth Authentication

  • Basic Authentication

cURL
curl --request POST \
--url https://api.atoa.me/api/webhook/merchant \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com",
"event": "PAYMENTS_STATUS"
}'

Authorization

Bearer <token>

Request Body Schema

url
string
required

The endpoint URL that will receive webhook notifications. Must return HTTP 200 on success — failed deliveries are retried with exponential back-off.

event
string
required

The event type to subscribe to: PAYMENTS_STATUS, EXPIRED_STATUS, REFUND_STATUS, or POS_PAYMENT_STATUS.

authentication
object

Optional authentication configuration for your webhook endpoint.

Response

webhookId
string

Unique identifier for the created webhook.

url
string

The registered webhook URL.

event
string

The subscribed event type.