Get fiat ramp limits
Returns both on-ramp and off-ramp limits in one request. Top-level fields stay the selected rampProvider (default avenia) so existing clients do not break. providers lists remaining limits for every ramp provider with approved KYC on this wallet. UnblockPay remaining uses configurable per-customer USD caps minus committed extract volume (shared onramp/offramp bucket). Each directional object contains the effective remaining amount in the requested currency after applying both the matching local cap and the global USD cap, plus the remaining global cap in USD. The top-level remaining fields are deprecated aliases for the off-ramp values.
Authorizations
API key for authentication. Obtain from your Pods dashboard.
Query Parameters
Three-letter ISO currency code used for local limit values
^[A-Z]{3}$"BRL"
Wallet address linked to the approved KYC profile
"0x0000000000000000000000000000000000000001"
Selects the top-level remaining-limit object. Omitted or empty defaults to avenia. The additive providers array still lists every approved ramp provider.
"avenia"
Response
Directional ramp limits retrieved, or no applicable provider found
- Option 1
- Option 2
Provider selected by rampProvider (default avenia). Top-level remaining fields stay this provider so existing clients do not break.
"avenia"
Requested three-letter ISO currency code
"BRL"
Remaining limits for every ramp provider with approved KYC on this wallet. UnblockPay remaining is the tightest USD window of the customer limits profile, converted into the requested currency. BRL remaining is omitted when that conversion is missing. The whole UnblockPay snapshot is availability unavailable, without amounts, when neither the limits profile nor the extract can be read.
Backward-compatible alias for offramp.remaining
"5500"
Backward-compatible alias for offramp.remainingGlobalUsd
"1100"
Whether the selected provider has blocked the account. Both directional remaining values are zero when true. UnblockPay does not set this.
false
UnblockPay only. unavailable when neither the limits profile nor the extract can be read, or when the USD conversion is missing. Rivool blocks new operations in that case. Omitted by Avenia.
available, unavailable "available"
UnblockPay USD windows: transaction, day, month, and year. UnblockPay publishes no annual ceiling, so the year window mirrors the month: twelve times the month cap against the month usage. Omitted when no snapshot can be read.
UnblockPay window that restricts the available amount.
transaction, day, month, year "day"
When the numbers behind these values were read. A cache hit keeps this instant instead of stamping the response.
"2026-09-18T22:00:00.000Z"
Present for UnblockPay. provider_limits means the caps and usage come from the customer limits profile UnblockPay approved. configured_caps means the limits profile could not be read and the snapshot falls back to configured ceilings minus committed extract volume, which overstates headroom.
provider_limits, configured_caps "provider_limits"
Present for UnblockPay when deposit and withdrawal share the same USD consumption.
combined "combined"