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-VersionstringThe 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.
"2026-12-01"Query parameters
limitintegerItems per page, 1 to 100. A value outside that range returns 400 invalid_limit.
cursorstringOpaque cursor returned by a previous list response. Omit for the first page.
typestringOnly 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 · requiredlistdataarray of object · requiredItem fields (7)
idstring · requiredUnique identifier, prefixed evt_.
objectstring · requiredThe type of the object.
eventlivemodeboolean · requiredTrue in production, false in the sandbox.
typestring · requiredThe 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 · requiredThe API version data.object is rendered at.
"2026-12-01"dataobject · requiredThe event data.
Fields (1)
objectobject | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object | object · requiredThe resource the event is about, as the API returns it.
created_atstring (date-time) · requiredWhen the event was created.
"2026-04-15T14:30:00Z"has_moreboolean · requiredWhether more results exist beyond this page.
next_cursorstring | null · requiredOpaque 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 · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe 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_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."401Missing, expired or invalid credentials (access token or DPoP proof). Carries `WWW-Authenticate`.
errorobject · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe 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_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"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 · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe 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_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"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 · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe 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_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"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 · requiredThe error object of every /v1 error response. type, code, message, doc_url and request_id are always present.
Fields (7)
typestring · requiredThe 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_errorcodestring · requiredMachine-readable error code. Branch on this, not on message. Each code is documented at its doc_url.
"amount_precision_invalid"messagestring · requiredHuman-readable description for a developer. Never includes personal data or internal detail; a 5xx message is always generic.
"CAD amounts allow 2 decimal places; got 3."doc_urlstring (uri) · requiredWhere this code is documented.
"https://docs.antonpayments.com/api-reference/errors#amount_precision_invalid"request_idstring · requiredThe req_ ID of the request that failed; the same value as the Request-Id header.
"req_01JD3XB7Q2"paramstringThe request field or query parameter at fault, when one is. With several failures, see details.
"amount"detailsarray of objectEvery field failure at once, so a form can be fixed in one pass.
Item fields (3)
paramstring · requiredDotted JSON path to the offending field.
"amount"codestring · required"amount_precision_invalid"messagestring · required"CAD amounts allow 2 decimal places; got 3."