Skip to main content
GET
Get fiat ramp limits

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your Pods dashboard.

Query Parameters

currency
string
required

Three-letter ISO currency code used for local limit values

Pattern: ^[A-Z]{3}$
Example:

"BRL"

originAddress
string
required

Wallet address linked to the approved KYC profile

Example:

"0x0000000000000000000000000000000000000001"

rampProvider
string

Selects the top-level remaining-limit object. Omitted or empty defaults to avenia. The additive providers array still lists every approved ramp provider.

Example:

"avenia"

Response

Directional ramp limits retrieved, or no applicable provider found

provider
string
required

Provider selected by rampProvider (default avenia). Top-level remaining fields stay this provider so existing clients do not break.

Example:

"avenia"

currency
string
required

Requested three-letter ISO currency code

Example:

"BRL"

onramp
object
required
offramp
object
required
providers
object[]
required

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.

remaining
string
deprecated

Backward-compatible alias for offramp.remaining

Example:

"5500"

remainingGlobalUsd
string
deprecated

Backward-compatible alias for offramp.remainingGlobalUsd

Example:

"1100"

blocked
boolean

Whether the selected provider has blocked the account. Both directional remaining values are zero when true. UnblockPay does not set this.

Example:

false

availability
enum<string>

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 options:
available,
unavailable
Example:

"available"

windows
object[]

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.

limitingPeriod
enum<string>

UnblockPay window that restricts the available amount.

Available options:
transaction,
day,
month,
year
Example:

"day"

observedAt
string<date-time>

When the numbers behind these values were read. A cache hit keeps this instant instead of stamping the response.

Example:

"2026-09-18T22:00:00.000Z"

source
enum<string>

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.

Available options:
provider_limits,
configured_caps
Example:

"provider_limits"

scope
enum<string>

Present for UnblockPay when deposit and withdrawal share the same USD consumption.

Available options:
combined
Example:

"combined"