API reference · version 2026-12-01
API reference
Built from the same OpenAPI file the API is checked against. Generate a client from it and you are coding against the exact contract.
Sandboxhttps://api.antonpayments.devProductionhttps://api.antonpayments.com
Authentication
Reference Data
Beneficiaries
/v1/beneficiaries- POSTCreate a beneficiary
/v1/beneficiaries - GETList beneficiaries
/v1/beneficiaries - GETRetrieve a beneficiary
/v1/beneficiaries/{id} - PATCHUpdate a beneficiary
/v1/beneficiaries/{id} - DELETEDelete a beneficiary
/v1/beneficiaries/{id} - PATCHUpdate a beneficiary's personal details
/v1/beneficiaries/{id}/pii - POSTArchive a beneficiary
/v1/beneficiaries/{id}/archive - POSTRestore a beneficiary
/v1/beneficiaries/{id}/restore - POSTRe-screen a beneficiary
/v1/beneficiaries/{id}/rescreen - GETDownload the beneficiary import template
/v1/beneficiaries/import/template - POSTPreview a bulk beneficiary import
/v1/beneficiaries/import - POSTConfirm a beneficiary import
/v1/beneficiaries/import/{import_id}/confirm - GETRetrieve a beneficiary's personal details
/v1/beneficiaries/{id}/pii
Instruments
/v1/instruments- POSTCreate an instrument
/v1/instruments - GETList instruments
/v1/instruments - GETList countries available for instruments
/v1/instruments/countries - GETList payment-method schemas
/v1/instruments/methods - GETRetrieve an instrument
/v1/instruments/{id} - PATCHUpdate an instrument
/v1/instruments/{id} - DELETEDelete an instrument
/v1/instruments/{id}
Intelligence
/v1/intelligence/evaluationsReviews
/v1/intelligence/reviews- GETList reviews
/v1/intelligence/reviews - GETGet a review
/v1/intelligence/reviews/{id} - GETGet review settings
/v1/intelligence/reviews/settings - POSTRecord a decision
/v1/intelligence/reviews/{id}/decisions - POSTResume a review
/v1/intelligence/reviews/{id}/resume - POSTAdd a note
/v1/intelligence/reviews/{id}/notes - GETExport reviews as CSV
/v1/intelligence/reviews/export - GETExport a case file (PDF)
/v1/intelligence/reviews/{id}/case-file
Verifications
- POSTCreate a verification subject
/v1/verification-subjects - GETList verification subjects
/v1/verification-subjects - GETGet a verification subject
/v1/verification-subjects/{id} - POSTRe-verify a subject
/v1/verification-subjects/{id}/verifications - POSTResend a verification link
/v1/verifications/{id}/resend - POSTRegenerate a verification
/v1/verifications/{id}/regenerate - POSTRevoke a verification
/v1/verifications/{id}/revoke - POSTResend an owner's verification link
/v1/verifications/{id}/owners/resend - GETVerification stats
/v1/verification-stats - POSTRe-screen a verification
/v1/verifications/{id}/rescreen
Payouts
/v1/payoutsBatches
/v1/batches- GETDownload the batch template
/v1/batches/template - POSTUpload a batch
/v1/batches - GETList batches
/v1/batches - GETRetrieve a batch
/v1/batches/{id} - POSTConfirm a validated batch
/v1/batches/{id}/confirm - POSTCancel a batch
/v1/batches/{id}/cancel - GETList payouts created from a batch
/v1/batches/{id}/payouts - GETList batch beneficiaries
/v1/batches/{id}/beneficiaries - GETList batch validation errors
/v1/batches/{id}/errors - GETList per-row processing results
/v1/batches/{id}/results
Balances
/v1/balancesAccounts
Webhooks
/v1/webhooks- POSTCreate a webhook subscription
/v1/webhooks - GETList webhook subscriptions
/v1/webhooks - GETRetrieve a webhook subscription
/v1/webhooks/{id} - PATCHUpdate a webhook subscription
/v1/webhooks/{id} - DELETEDelete a webhook subscription
/v1/webhooks/{id} - POSTRotate the signing secret
/v1/webhooks/{id}/secret/rotate - POSTSend a test delivery
/v1/webhooks/{id}/test - POSTDeactivate a subscription
/v1/webhooks/{id}/deactivate - GETList webhook events
/v1/webhooks/events - GETRetrieve a webhook event
/v1/webhooks/events/{id} - GETList deliveries for an event
/v1/webhooks/events/{id}/deliveries - POSTActivate a webhook subscription
/v1/webhooks/{id}/activate - GETSummarise webhook deliveries
/v1/webhooks/summary - GETList webhook event types
/v1/webhooks/event-types - GETList an endpoint's deliveries
/v1/webhooks/{id}/deliveries
Pricing
/v1/pricingFX
/v1/fxCorridors
/v1/corridorsSandbox
/v1/sandbox/deposits