Anton.Docs
Dashboard (opens in a new tab)

List webhook events

GET/v1/webhooks/events

Events recorded for your account, newest first. created_after is inclusive and created_before is exclusive. Without them, the list reaches back to the first event. Pages use an opaque cursor.

Headers

Anton-Versionstring

The API version for this request, a date such as 2026-12-01. Optional. Without it, the request runs on your account's pinned version: the latest version when you created your first OAuth client, or the launch version (2026-12-01) if you have not created one. An unknown value returns 400 invalid_api_version. The header applies to one request and never changes your pinned version; move the pin from the dashboard. It does not apply to webhooks, which follow your pinned version. The response echoes the version used in the Anton-Version header.

Example: "2026-12-01"

Query parameters

limitinteger

Items per page, 1 to 100. A value outside that range returns 400 invalid_limit.

cursorstring

Opaque cursor returned by a previous list response. Omit for the first page.

typestring

Only events of this type. A type that is not in the catalog returns 400 invalid_request.

payout.createdpayout.approvedpayout.processingpayout.sentpayout.completedpayout.failedpayout.cancelledpayout.returnedpayout.on_holdpayout.approval_requiredpayout.approval_expiredpolicy.matchedbeneficiary.createdbeneficiary.updatedbeneficiary.deletedbeneficiary.blockedinstrument.createdinstrument.updatedinstrument.deletedbatch.uploadedbatch.completedbatch.failedschedule.executedschedule.failedschedule.pausedbalance.lowfunding.creditfx.quote.createdfx.exchange.createdfx.exchange.completedfx.exchange.failedverification.link_sentverification.startedverification.approvedverification.declinedverification.reviewverification.expiredintelligence.evaluation.completedintelligence.evaluation.failedinsight.createdintelligence.review.openedintelligence.review.decision_proposedintelligence.review.decidedintelligence.review.reopenedintelligence.review.closedintelligence.review.overdueintelligence.review.note_addedtest*
created_afterstring (date-time)

Only objects created at or after this timestamp (inclusive), such as 2026-11-01T00:00:00.000Z. Use RFC 3339 UTC with millisecond precision and a Z suffix. Anything else returns 400 invalid_request with param set.

created_beforestring (date-time)

Only objects created before this timestamp (exclusive). Use RFC 3339 UTC with millisecond precision and a Z suffix, such as 2026-11-01T00:00:00.000Z. Anything else returns 400 invalid_request with param set.

Responses

200A page of events.
objectstring · required
list
dataarray of object · required
Item fields (7)
idstring · required

Unique identifier, prefixed evt_.

objectstring · required

The type of the object.

event
livemodeboolean · required

True in production, false in the sandbox.

typestring · required

The event type.

payout.createdpayout.approvedpayout.processingpayout.sentpayout.completedpayout.failedpayout.cancelledpayout.returnedpayout.on_holdpayout.approval_requiredpayout.approval_expiredpolicy.matchedbeneficiary.createdbeneficiary.updatedbeneficiary.deletedbeneficiary.blockedinstrument.createdinstrument.updatedinstrument.deletedbatch.uploadedbatch.completedbatch.failedschedule.executedschedule.failedschedule.pausedbalance.lowfunding.creditfx.quote.createdfx.exchange.createdfx.exchange.completedfx.exchange.failedverification.link_sentverification.startedverification.approvedverification.declinedverification.reviewverification.expiredintelligence.evaluation.completedintelligence.evaluation.failedinsight.createdintelligence.review.openedintelligence.review.decision_proposedintelligence.review.decidedintelligence.review.reopenedintelligence.review.closedintelligence.review.overdueintelligence.review.note_addedtest*
api_versionstring · required

The API version data.object is rendered at.

Example: "2026-12-01"
dataobject · required

The event data.

Fields (1)
objectobject | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object · required

The resource the event is about, as the API returns it.

created_atstring (date-time) · required

When the event was created.

Example: "2026-04-15T14:30:00Z"
has_moreboolean · required

Whether more results exist beyond this page.

next_cursorstring | null · required

Opaque cursor for the next page, null on the last page.

400An unknown query parameter or event type, a timestamp that does not parse, a `limit` outside 1 to 100, or a malformed `cursor`.
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
401Missing, expired or invalid credentials (access token or DPoP proof). Carries `WWW-Authenticate`.
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
403Authenticated, but not permitted for this operation. A sandbox credential used against production is `key_environment_mismatch`.
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
429Rate limit exceeded. See `Retry-After`. The `X-RateLimit-*` headers are on every authenticated API response, not only on 429s; they are docu
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."
500Something went wrong on our end (`api_error`: 500 `internal_error`, 502 `upstream_error`, 503 `service_unavailable`). The message is always
errorobject · required

The error object of every /v1 error response. type, code, message, doc_url and request_id are always present.

Fields (7)
typestring · required

The kind of error; it follows the HTTP status. idempotency_error is used only for the two Idempotency-Key failures that are a 409 or a 422 (idempotency_in_flight, idempotency_key_reused).

authentication_errorpermission_errorinvalid_request_erroridempotency_errorrate_limit_errorapi_error
codestring · required

Machine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.

Example: "amount_precision_invalid"
messagestring · required

Human-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.

Example: "CAD amounts allow 2 decimal places; got 3."
doc_urlstring (uri) · required

Where this code is documented.

Example: "https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"
request_idstring · required

The req_ ID of the request that failed; the same value as the Request-Id header.

Example: "req_01JD3XB7Q2"
paramstring

The request field or query parameter at fault, when one is. With several failures, see details.

Example: "amount"
detailsarray of object

Every field failure at once, so a form can be fixed in one pass.

Item fields (3)
paramstring · required

Dotted JSON path to the offending field.

Example: "amount"
codestring · required
Example: "amount_precision_invalid"
messagestring · required
Example: "CAD amounts allow 2 decimal places; got 3."

Something wrong or missing here? Open an issue (opens GitHub in a new tab) ↗