API Reference

Limits overview

Use the Limits API to read the transfer tier of a customer or a remitter, the cap for each window and what is left to send. Check it before a large payout, or to see why a transfer paused. All amounts are USD strings.

Read a customer's limits or browse the operations in this category.

Read the limits response and see when a transfer will pause.

How it works

When your business has a limits policy, Gravv does not refuse a transfer over a cap. The transfer returns transfer_status paused, with the window in breached_window, the amount left in remaining_usd, and what would release it in requirements. Resume it with POST /v1/transfer/{id}/resume, or let it expire. See Paused transfers.

The smallest remaining_usd across the windows is the most the sender can send now. A cap_usd of null means no cap in that window.
mode is off, shadow (Gravv measures usage but pauses nothing) or enforce.
A 404 not found: no limits policy applies means your business has no limits policy.

Endpoints

Endpoint	Description
`GET /v1/customers/{customer_id}/limits`	Get a customer's tier, caps and what is left in each window
`GET /v1/limits/remitters/{remitter_id}`	Get the same view for a remitter you name on transfers

Authentication

All requests use https://api.gravv.xyz and authenticate with the Api-Key header. See Authentication for details.

Was this page helpful?