Skip to main content
GET
Get blocked banks for a fiat ramp provider

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain from your Pods dashboard.

Query Parameters

currency
string
default:BRL

Fiat currency, normalized to uppercase

Pattern: ^[A-Z]{3}$
kycUserId
string<uuid>

KYC user owned by the authenticated customer; must have a linked account for the selected provider

limit
integer
default:10000

Page size. Defaults to 10000 so one request still returns the full current list.

Required range: 1 <= x <= 10000
page
integer
default:1

1-based page index into the cached restriction snapshot

Required range: x >= 1
paymentMethod
string
default:PIX

Fiat payment method, normalized to uppercase

Minimum string length: 1
rampProvider
string
default:avenia

Registered ramp provider enabled for this customer; normalized to lowercase

Response

One page of blocked banks, including an empty page when the provider reports none or the page is past the end

provider
string
required
currency
string
required
paymentMethod
string
required
scope
enum<string>
required
Available options:
account,
user
fetchedAt
string<date-time>
required
data
object[]
required
pagination
object
required

Standard list pagination metadata