POST
/
api
/
webhook
/
test
curl --request POST \
  --url https://api.atoa.me/api/webhook/test \
  --header 'Authorization: Bearer <sandbox-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "eventType": "PAYMENTS_STATUS"
}'
{
  "message": "Test webhook triggered successfully."
}

Sends a test webhook to your sandbox URL. Body and signature match a production event — verify your endpoint without creating a real payment.

Sandbox-only — production keys are rejected. Delivers to the URL registered via Create webhook event for the specified eventType.

Authorization

Bearer <sandbox-token>

Request Body Schema

eventType
string
required

The webhook event to simulate.

orderId
string

Override the orderId. Defaults to a generated test value.

amount
number

Override the paidAmount in pounds (e.g. 10.05 for £10.05). Defaults to a test value.

paymentMethod
string

Override the paymentMethod.

status
string

Override the status. Valid values depend on eventType:

type
string

POS_PAYMENT_STATUS only — selects which body shape to dispatch.

Rejected for non-POS events.

customFields
array

POS_PAYMENT_STATUS only — custom field entries for the payload. Defaults to a test fixture. Rejected for non-POS events.

Response

message
string

Confirmation that the test webhook was dispatched. Payload arrives at your registered URL asynchronously.