Anton.Docs
Dashboard (opens in a new tab)

Respond to an RFI

An RFI is answered by a person in the dashboard. Your integration cannot answer one, so its job is to keep the payout waiting and tell your team.

An RFI is a request for information from Anton. A payout or review that is waiting on it moves on once your team answers.

RFIs are coming to the API as an additive change. Nothing you build today changes shape, and the changelog will say when it can answer for you.

Before you begin

Decide who answers

A person signed in to the dashboard answers: they open the RFI, write the response and attach documents. The rfis.respond permission allows it, and the Admin and Operator roles hold it. No API credential can respond, whatever its scope, so your integration needs a step that tells a person to act.

RFIs exist on every account tier, including accounts that hold only the intelligence capability. Make sure someone on your team holds the role.

What your integration can see

There is no RFI object, endpoint or webhook event. A subscription that names an rfi.* type is refused with 422 validation_error.

You see the payout. One that is under review has status on_hold. The API cannot tell you whether a hold is waiting on an RFI, so treat every on_hold payout as possibly waiting on one and check the dashboard.

GET/v1/payouts/{id}Read a held payout

status is on_hold and status_message is the only text. It does not mention an RFI.

Reference
Not yet tested in sandbox
curl https://api.antonpayments.dev/v1/payouts/pay_dbvqrpqukoh470i0a400 \
  -H "Authorization: DPoP $ANTON_ACCESS_TOKEN" \
  -H "DPoP: $DPOP_PROOF"

Handle holds and reviews covers the payout side in full.

What to build

1
Notify the people who can answer

On payout.on_hold, send the Admin and Operator holders a message with the payout id and a link to your dashboard view. They check for an open RFI.

2
Keep the payout where it is

A held payout cannot be cancelled, and a second payout for the same invoice risks paying twice. Wait for payout.processing, payout.failed or payout.cancelled.

3
Show your user a pending state

Don't present Anton's status_message as a reason. It gives none.

4
Alert on age

Flag a payout that stays on hold past your own deadline, and an RFI that stays open past it.

When it goes wrong

409payout_on_hold
You tried to cancel a payout under review. Wait for the hold to end.
422validation_error
You subscribed to an event type that does not exist, such as an rfi.* name. Take names from GET /v1/webhooks/event-types.
404resource_missing
The payout does not exist or belongs to another merchant.

A payout that ends failed with failure_code cannot_be_processed comes with no detail. Contact support at help.antonpayments.com with the payout id and the request_id.

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