Skip to main content
An approval (apr_*) holds a payment or other money movement that broke one of your limits. Nothing moves until it’s approved. To learn more, see Approve or deny a held payment.

Example

GET /approvals/{approvalId}
The object is everything inside data. The field names below are relative to it: attributes.status is data.attributes.status in the response.

Fields

string
required
Resource type. Always approval.
string
required
Approval ID (apr_*).
object
required
The approval’s details.
object
required
Resources the approval links to.

Statuses

Who resolves an approval

An approval belongs to the party that owns the limit it breached, and only that party sees it. A hold from your party’s limits or your agents’ limits is yours; a hold from a limit a customer set on their connection with your agent is that customer’s. Owners, admins and API keys with payments.create can approve or deny; agents can’t.

Events

Errors

See the error codes these endpoints return.

Sandbox simulations

None.