Anton.Docs
Dashboard (opens in a new tab)
How it works

How Anton evaluates payouts

A payout is screened and risk-scored before any rail sees it, so the create call returns early and the outcome arrives as a status change.

POST /v1/payouts does not submit to a rail. Anton checks the payout first, and the result shows up in its status and in the payout.* webhook events that announce each change.

What happens to every payout

1
Checks

The payout and its beneficiary are screened and risk-scored before any funds move. A payout that needs a closer look goes on_hold, and Anton does not say why.

2
Your approval policy

If your own approval policy needs a second person, the payout waits as pending_approval. A payout your policy blocks outright is refused with 422 policy_blocked.

3
Rail submission

A payout that clears every check moves to processing and is submitted to the rail. sent and completed come from the rail.

You cannot disable the checks, override them at submission or skip them with a flag. A payout Anton cannot process is refused with 422 cannot_be_processed, and the response never says why.

Status transitions

FromTo
createdpending_approval, processing, on_hold
pending_approvalprocessing, cancelled
processingon_hold, sent, failed, cancelled
on_holdprocessing, cancelled, failed
sentcompleted, failed, returned

completed, returned, cancelled and failed are final. Treat a status you do not know as in progress.

What each status means

StatusMeaningWhat to do
createdAccepted. Screening starts as the payout is created, so a new payout usually reads processing already.Treat it as in progress.
pending_approvalWaiting for a second person on your team to approve it, under your own approval policy.Nothing.
processingBeing checked and prepared, or submitted to the rail.Show it as in flight.
on_holdHeld for review. status_message is the only text Anton gives.Show a pending state, not an error. A held payout cannot be cancelled: the request returns 409 payout_on_hold.
sentThe rail confirmed dispatch.Show it as sent.
completedThe beneficiary received the funds.Mark it done.
returnedThe funds came back after being sent.Reconcile the return in your books.
failedThe payout did not go through. failure_code is one of provider_rejected, provider_unavailable, insufficient_funds, beneficiary_not_found, or cannot_be_processed when Anton could not process it.Read failure_code. For cannot_be_processed there is no further detail: contact support with the payout id and the request_id.
cancelledCancelled by you before submission.Nothing.

What your integration should do

Subscribe to webhooks and do not poll. Status changes are pushed to you, and polling spends rate limit to learn the same thing later.

Treat a hold as a normal state. Show your end user a pending state. The payout leaves on_hold for processing, cancelled or failed.

What you send changes what Anton can see

Anton scores what it is given. Send the session object on POST /v1/payouts: the end user's IP, timezone and user agent as your own edge observed them.

Without it the only address in the request is your server's. With it, Anton can use IP geolocation and network type, check whether the timezone agrees with where the address resolves, and follow a device across sessions.

Every field is optional. Only an ip that is not a valid address is rejected, with 422. Anything else that looks wrong, such as a private ip, an unrecognised timezone or a future started_at, is accepted and reported back in the payout's session_quality array. See Create a payout.

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