> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pods.finance/llms.txt
> Use this file to discover all available pages before exploring further.

# Get blocked banks for a fiat ramp provider

> Returns one page of the effective bank restrictions for one ramp provider, currency and payment method. The default page size is 10000, so one request still returns the current full list. Avenia BRL/PIX is initially supported. Other providers or rails return BANK_RESTRICTIONS_NOT_SUPPORTED rather than an empty list. Omit kycUserId for the provider main account; supply an owned active KYC user to resolve that provider account, without requiring KYC approval or falling back to the main account. Account overrides are resolved by the provider. Results may be cached for up to 30 seconds per customer, provider, resolved account, currency and payment method; fetchedAt records the upstream read. Individual malformed upstream rows are omitted; a payload that is not a bank list returns INVALID_BANK_RESTRICTIONS_RESPONSE. This endpoint is informational and does not change quote or payment validation.



## OpenAPI

````yaml /openapi.yaml get /api/v1/banks/blocked
openapi: 3.0.0
info:
  version: 2.0.0
  title: Pods API
  description: >
    # Pods API Documentation


    Pods API is a comprehensive DeFi aggregation platform that enables
    cross-chain and same-chain transactions for yield strategies.


    ## Key Features


    - **Cross-Chain Swaps**: Swap tokens across different blockchain networks

    - **Same-Chain Swaps**: Optimal routing for swaps within the same network

    - **Yield Strategies**: Access to multiple DeFi protocols (Aave, Morpho,
    Lido, etc.)

    - **Wallet Tracking**: Monitor positions and yields across protocols

    - **Transaction Monitoring**: Real-time status updates for cross-chain
    transactions


    ## Authentication


    Most API endpoints require authentication using an API key in the
    `x-api-key` header:


    ```

    x-api-key: your-api-key-here

    ```


    Obtain your API key from the Pods dashboard.


    **Exceptions:**

    - `GET /health` is public and does not require authentication.

    - Customer dashboard endpoints (e.g. `GET /customers/me`,
    `/customers/:id/tokens`, `/customers/:id/token-groups`) require a **Bearer**
    token (Supabase or Magic JWT). API key alone is not sufficient for these
    routes because they enforce user role checks.


    ## Base URL


    Production: `https://api.pods.finance`


    ## Rate Limits


    - New PLG customers awaiting approval share a configurable rolling 60-second
    quota across all API keys and authenticated dashboard requests (default: 10
    requests). HTTP 429 includes Retry-After.

    - These customers have a configurable USD limit per transaction (default:
    100), covering swaps, bridges, deposits, withdrawals, transfers and ramps.
    The API values the input with trusted prices; unavailable or invalid
    valuation returns HTTP 503.

    - Approval removes these PLG limits. Existing customers retain their
    ordinary access. Arbitrary calldata and legacy client-authored swap quotes
    require approval.


    ## Quote Expiration


    Quotes expire after 5 minutes. The `deadline` field is a Unix timestamp in
    seconds and `deadlineDate` is an ISO 8601 string (UTC); request a new quote
    when the deadline has passed.


    ## Error Handling


    All errors follow a consistent format. The HTTP status line is the source of
    truth — the body does **not** include `httpStatus`:


    ```json

    {
      "error": {
        "code": "ERROR_CODE",
        "message": "Human-readable error message",
        "details": {}
      }
    }

    ```


    ## Common Error Codes


    - **SETTLEMENT_WEBHOOK_REGISTRATION_PENDING** (503): Source-chain transfer
    monitoring is not ready; retry the same quote acceptance

    - **NATIVE_SCAN_INITIALIZATION_PENDING** (503): Native deposit monitoring is
    temporarily unavailable; retry activation

    - **SWAP_STATUS_UPDATE_DEPRECATED** (410): This endpoint is retired. Use GET
    /v2/swap/:id/fulfill?txHash=... instead, then poll GET /v2/swap/status/:id
    for the quote status.

    - **QUOTE_NOT_FOUND** (404): Quote not found or expired

    - **ACTION_NOT_FOUND** (404): Action not found

    - **STRATEGY_NOT_FOUND** (404): Strategy not found

    - **RECURRING_COLLECTION_REQUIRES_FEE** (400): Recurring collection requires
    a performance or markup fee configured

    - **RECURRING_MARKUP_RECIPIENT_REQUIRED** (422): Live recurring collection
    with a markup fee requires a non-zero markup fee recipient

    - **MARKUP_RECIPIENT_CONFLICTS_WITH_PERFORMANCE_COLLECTOR** (422): Markup
    fee recipient cannot be the performance fee collector

    - **RECURRING_RECIPIENT_ROTATION_PENDING_DISPATCH** (409): Markup fee
    recipient cannot be rotated while a recurring collection transaction is
    unresolved

    - **RECURRING_REGISTRY_CONTROLLER_NOT_CONFIGURED** (503): Recurring
    collection controller is not configured for this network

    - **RECURRING_REGISTRY_MISMATCH** (409): On-chain recurring collection
    registry is not synchronized

    - **INVALID_ACTION_TYPE** (400): Action type is not supported for this
    endpoint

    - **QUOTE_EXPIRED** (400): Quote has expired

    - **QUOTE_VALIDATION_ERROR** (400): Quote validation failed

    - **PIX_THIRD_PARTY_QUOTE_MISMATCH** (400): thirdParty must match the Pix
    offramp quote

    - **MISSING_PIX_KEY** (400): pixKey is required to create the BRL Pix payout
    ticket

    - **INVALID_PIX_KEY** (400): The Pix key is invalid or was not found

    - **PIX_KEY_LOOKUP_FAILED** (502): Unable to validate the Pix key. Please
    try again later

    - **INVALID_PIX_BRCODE_FORMAT** (400): pixKey looks like a Pix BR Code but
    failed format/checksum validation

    - **PIX_BRCODE_EXPIRED** (400): This Pix BR Code has expired

    - **PIX_BRCODE_LOOKUP_FAILED** (502): Failed to look up Pix BR Code details
    from Avenia

    - **PIX_BRCODE_REQUOTE_REQUIRED** (400): This Pix BR Code has a fixed amount
    that was not priced into the existing quote; request a new quote

    - **PROVIDER_NOT_FOUND** (404): Swap provider not found

    - **NO_ROUTE_FOUND** (400): No swap route available between specified chains

    - **INVALID_PREFERRED_PROVIDER** (400): Unknown preferredProvider name

    - **PREFERRED_PROVIDER_NOT_ELIGIBLE** (400): preferredProvider is not
    eligible for this swap route

    - **PREFERRED_PROVIDER_QUOTE_UNAVAILABLE** (400): No quote was returned for
    the requested preferredProvider

    - **INVALID_RAMP_PROVIDER** (400): Unknown rampProvider name

    - **RAMP_PROVIDER_NOT_ELIGIBLE** (400): rampProvider is not eligible for
    this fiat ramp route

    - **RAMP_AMOUNT_OUT_OF_RANGE** (422): Amount is outside the range this ramp
    provider accepts

    - **RAMP_ACCOUNT_ID_MISSING** (400): KYC profile is missing the selected
    ramp provider account id

    - **BANK_RESTRICTIONS_NOT_SUPPORTED** (400): Bank restrictions are not
    supported for this provider, currency and payment method

    - **INVALID_BANK_RESTRICTIONS_RESPONSE** (502): Invalid bank restrictions
    response from provider

    - **BANK_RESTRICTIONS_FETCH_FAILED** (502): Failed to fetch bank
    restrictions from provider

    - **BANK_RESTRICTIONS_FETCH_TIMED_OUT** (504): Bank restrictions request to
    the provider timed out

    - **UNBLOCKPAY_NOT_CONFIGURED** (500): UnblockPay API key is not configured

    - **UNBLOCKPAY_API_ERROR** (502): UnblockPay API request failed

    - **INVALID_UNBLOCKPAY_QUOTE** (502): UnblockPay quote is missing required
    fields

    - **INVALID_UNBLOCKPAY_TICKET** (502): UnblockPay transaction is missing
    required fields

    - **INVALID_UNBLOCKPAY_CUSTOMER** (502): UnblockPay customer is missing
    required fields

    - **UNBLOCKPAY_KYC_NOT_PROVISIONED** (409): UnblockPay customer is not
    provisioned on this KYC profile

    - **UNBLOCKPAY_KYC_REJECTED** (409): UnblockPay KYC was rejected and cannot
    be retried from this profile

    - **UNBLOCKPAY_KYC_IN_PROGRESS** (409): UnblockPay KYC is already under
    review

    - **UNBLOCKPAY_USD_OFFRAMP_ACCOUNT_MISSING** (409): UnblockPay USD offramp
    needs a wire external account. POST /api/v1/kyc/currency-unlock with
    rampProvider=unblockpay and the bank fields listed on
    ramps.unblockpay.unlock.requiredBodyFields

    - **UNBLOCKPAY_WIRE_BENEFICIARY_COUNTRY_UNSUPPORTED** (422): UnblockPay USD
    wire requires a US beneficiary address (beneficiaryCountry USA)

    - **UNBLOCKPAY_WIRE_EXTERNAL_ACCOUNT_NOT_APPROVED** (409): UnblockPay wire
    external account is not approved yet; retry once its review completes

    - **RAMP_RAIL_TEMPORARILY_UNAVAILABLE** (503): The ramp provider has
    temporarily disabled this payment rail; retry later

    - **USD_WIRE_ACCOUNT_MISMATCH** (409): Wire account number and routing
    number do not match the registered account

    - **KYC_PROFILE_INCOMPLETE_FOR_RAMP** (400): KYC profile is missing fields
    required by the selected ramp provider

    - **KYC_WALLET_ALREADY_LINKED** (409): Wallet is already linked to another
    KYC profile for this customer

    - **KYC_WALLET_NOT_LINKED** (404): Wallet is not linked to this KYC profile

    - **KYC_LAST_WALLET** (409): Cannot unlink the last wallet from a KYC
    profile

    - **QUOTE_GENERATION_FAILED** (400): Could not generate quote for specified
    parameters

    - **ROUTER_EXACT_OUT_UNSUPPORTED** (400): Router public Pix/Yield quotes
    currently support amountIn only

    - **FEE_SPONSORSHIP_NOT_ALLOWED** (403): Fee sponsorship is not allowed for
    this customer

    - **WITHDRAW_AMOUNT_BELOW_PENDING_FEE** (422): The withdrawal amount does
    not cover the pending profit fees on this position

    - **MARKUP_BPS_BELOW_FLOOR** (422): markupBps is below the allowed floor

    - **MARKUP_BPS_ABOVE_MAX** (422): markupBps is above the maximum fee

    - **MARKUP_RECIPIENT_NOT_CONFIGURED** (422): A positive markupBps requires a
    configured customer fee collector for this operation

    - **MARKUP_SPONSORSHIP_CONFLICT** (422): feeSponsorship cannot be combined
    with a negative markupBps; sponsorship already waives the whole Pods fee

    - **MARKUP_OVERRIDE_NOT_ALLOWED** (422): markupBps cannot be applied by any
    eligible route or by the preferred provider

    - **CUSTOMER_STRATEGY_NOT_FOUND** (404): Customer strategy not found

    - **FEE_ACTIVATION_IN_PROGRESS** (409): Profit fee activation is already
    reconciling

    - **FEE_ACTIVATION_TASK_NOT_PERSISTED** (500): Fee activation task could not
    be persisted

    - **PAYMENT_NOT_FINALIZED** (422): Solana payment transaction was confirmed
    but did not reach finality within the verification wait window; retry the
    fulfill request

    - **PAYMENT_VERIFICATION_UNAVAILABLE** (503): Chain-native payment evidence
    is temporarily unavailable (EVM RPC, Solana RPC or Stellar Horizon
    unreachable, or the payment block is not yet canonical); retry the same
    fulfill request after a short delay

    - **PAYMENT_EVIDENCE_ALREADY_USED** (409): The submitted transaction hash is
    already recorded as payment evidence for another quote and cannot be reused

    - **INVALID_TX_HASH** (400): Invalid transaction hash format

    - **TX_UPDATE_FAILED** (500): Failed to update transaction status

    - **INVALID_AMOUNT_PARAMS** (400): Cannot specify both amountIn and
    amountOut simultaneously

    - **MISSING_AMOUNT_PARAMS** (400): Either amountIn or amountOut is required

    - **INVALID_SLIPPAGE** (400): slippage must be a number between 0.0001 and
    0.5 (fraction of 1, e.g. 0.01 = 1%)

    - **AMOUNT_IN_TOO_LOW** (400): AmountIn is below the minimum for this route

    - **AMOUNT_IN_TOO_HIGH** (400): AmountIn exceeds available liquidity for
    this route. Try a smaller amount.

    - **AMOUNT_IN_TOO_LOW_OFFRAMP** (400): AmountIn must be greater than 1 USDC

    - **AMOUNT_IN_TOO_HIGH_OFFRAMP** (400): AmountIn must be less than 20k USDC

    - **AMOUNT_OUT_TOO_LOW_OFFRAMP** (400): AmountOut is below the route minimum
    (0.5 BRL on Pix BRLA/BRS, 5 BRLA on USDC Pix)

    - **AMOUNT_OUT_TOO_HIGH_OFFRAMP** (400): AmountOut must be less than 110k
    BRLA

    - **AMOUNT_EXCEEDS_PROVIDER_LIMIT** (409): Requested amount exceeds the
    remaining provider withdrawal limit

    - **AMOUNT_EXCEEDS_LIMIT** (409): Amount exceeds the limit.

    - **AMOUNT_IN_TOO_LOW_ONRAMP** (400): AmountIn is below the route minimum
    (0.5 BRL on Pix BRLA/BRS, 1 BRLA on USDC Pix)

    - **AMOUNT_IN_TOO_HIGH_ONRAMP** (400): AmountIn must be at most 100k BRLA

    - **AMOUNT_OUT_TOO_LOW_ONRAMP** (400): AmountOut must be greater than 1 USDC

    - **AMOUNT_OUT_TOO_HIGH_ONRAMP** (400): AmountOut must be at most 20k USDC

    - **TRANSFER_VALIDATION_FAILED** (400): Token transfer validation failed

    - **REFUND_PROCESSING_FAILED** (500): Failed to process refund transaction

    - **INSUFFICIENT_AMOUNT_FOR_REFUND** (400): Transferred amount insufficient
    to cover refund fee

    - **FORBIDDEN** (403): Access denied

    - **ADDRESS_BLOCKED** (403): Address is not allowed to use this service

    - **INTERNAL_SERVER_ERROR** (500): An unexpected error occurred

    - **SERVICE_UNAVAILABLE** (503): Service temporarily unavailable

    - **BYTECODE_GENERATION_FAILED** (500): Failed to generate transaction
    bytecode

    - **SWAP_EXECUTION_FAILED** (500): Failed to execute swap transaction

    - **KAMINO_SERVICE_UNAVAILABLE** (503): Lending service is temporarily
    unavailable. Please try again later.

    - **KAMINO_BAD_REQUEST** (400): Invalid request to lending service

    - **DEPOSIT_NOT_FOUND** (404): Bitcoin deposit not found

    - **SYMBIOSIS_API_ERROR** (502): Error communicating with Symbiosis API

    - **STELLAR_ACCOUNT_NOT_FOUND** (400): Stellar account was not found on
    Horizon

    - **TRUSTLINE_REQUIRED** (400): Stellar account requires a USDC trustline
    before receiving funds

    - **TRUSTLINE_NOT_AUTHORIZED** (400): Stellar USDC trustline exists but is
    not authorized

    - **MUXED_DESTINATION_REQUIRED** (400): Offramp deposit requires a muxed
    Stellar destination (M…)

    - **NORA_NOT_CONFIGURED** (500): Nora API key is not configured

    - **NORA_API_ERROR** (502): Nora API request failed

    - **NORA_ONRAMP_AMOUNT_TOO_SMALL** (400): Nora onramp amount is below the
    minimum of 500 cents

    - **NORA_OFFRAMP_AMOUNT_TOO_SMALL** (400): Nora offramp amount is below the
    minimum of 500 cents

    - **INVALID_NORA_INTENT** (502): Nora intent is missing required fields

    - **ONDO_GM_NOT_CONFIGURED** (503): Ondo GM API is not configured.

    - **ONDO_GM_ATTESTATION_FAILED** (502): Ondo GM hard attestation request
    failed.

    - **ONDO_GM_SOFT_QUOTE_UNAVAILABLE** (502): Ondo GM soft quote is
    unavailable.

    - **ONDO_GM_FLOOR_BREACH** (409): Ondo GM hard attestation is worse than the
    bytecode floor.


    ## Support


    - Documentation: https://docs.pods.finance

    - Support: support@pods.finance
  contact:
    name: Pods Support
    email: support@pods.finance
    url: https://pods.finance
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.pods.finance
    description: Production server
security: []
tags:
  - name: Health
    description: Health check endpoints
  - name: KYC
    description: >-
      KYC onboarding and status endpoints: Brazilian and foreign Sumsub import,
      BigDataCorp capture, external evidence, linked wallets, and USD currency
      unlock
  - name: Swap
    description: Token swap operations
  - name: Tracking
    description: Execution tracking for swaps, transfers, and strategy operations
  - name: Strategies
    description: DeFi yield strategy operations
  - name: Ondo
    description: Ondo Global Markets stock status and tradability
  - name: Tokens
    description: Token catalog and metadata
  - name: Transfer
    description: Token transfer transaction generation
  - name: Wallets
    description: Wallet position tracking
  - name: Customers
    description: Customer account management (Bearer auth)
  - name: Quotes
    description: Quote history and management
  - name: Smart Account
    description: ERC-4337 Gnosis Safe smart account provisioning
paths:
  /api/v1/banks/blocked:
    get:
      tags:
        - Banks
      summary: Get blocked banks for a fiat ramp provider
      description: >-
        Returns one page of the effective bank restrictions for one ramp
        provider, currency and payment method. The default page size is 10000,
        so one request still returns the current full list. Avenia BRL/PIX is
        initially supported. Other providers or rails return
        BANK_RESTRICTIONS_NOT_SUPPORTED rather than an empty list. Omit
        kycUserId for the provider main account; supply an owned active KYC user
        to resolve that provider account, without requiring KYC approval or
        falling back to the main account. Account overrides are resolved by the
        provider. Results may be cached for up to 30 seconds per customer,
        provider, resolved account, currency and payment method; fetchedAt
        records the upstream read. Individual malformed upstream rows are
        omitted; a payload that is not a bank list returns
        INVALID_BANK_RESTRICTIONS_RESPONSE. This endpoint is informational and
        does not change quote or payment validation.
      parameters:
        - schema:
            type: string
            pattern: ^[A-Z]{3}$
            default: BRL
            description: Fiat currency, normalized to uppercase
          required: false
          name: currency
          in: query
        - schema:
            type: string
            format: uuid
            description: >-
              KYC user owned by the authenticated customer; must have a linked
              account for the selected provider
          required: false
          name: kycUserId
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 10000
            description: >-
              Page size. Defaults to 10000 so one request still returns the full
              current list.
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            minimum: 1
            default: 1
            description: 1-based page index into the cached restriction snapshot
          required: false
          name: page
          in: query
        - schema:
            type: string
            minLength: 1
            default: PIX
            description: Fiat payment method, normalized to uppercase
          required: false
          name: paymentMethod
          in: query
        - schema:
            type: string
            default: avenia
            description: >-
              Registered ramp provider enabled for this customer; normalized to
              lowercase
          required: false
          name: rampProvider
          in: query
      responses:
        '200':
          description: >-
            One page of blocked banks, including an empty page when the provider
            reports none or the page is past the end
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockedBanksResponse'
        '400':
          description: >-
            Unknown or disallowed provider, unsupported restrictions capability
            or rail, or missing linked provider account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Customer account is blocked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: KYC user not found, archived, or owned by another customer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: >-
            Upstream request failed, or the provider response was not a bank
            list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '504':
          description: Upstream request timed out
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BlockedBanksResponse:
      type: object
      properties:
        provider:
          type: string
        currency:
          type: string
        paymentMethod:
          type: string
        scope:
          type: string
          enum:
            - account
            - user
        fetchedAt:
          type: string
          format: date-time
        data:
          type: array
          items:
            type: object
            properties:
              bankCodeType:
                type: string
                description: Bank identifier scheme, currently ISPB for Brazilian Pix banks
                example: ISPB
              bankCode:
                type: string
                description: Bank identifier as a string, preserving leading zeros
                example: '00000001'
              bankName:
                type: string
                nullable: true
              blockedDirections:
                type: array
                items:
                  type: string
                  enum:
                    - onramp
                    - offramp
                minItems: 1
            required:
              - bankCodeType
              - bankCode
              - bankName
              - blockedDirections
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - provider
        - currency
        - paymentMethod
        - scope
        - fetchedAt
        - data
        - pagination
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              nullable: true
          required:
            - code
            - message
      required:
        - error
      example:
        error:
          code: QUOTE_NOT_FOUND
          message: Quote not found or expired
    Pagination:
      type: object
      properties:
        page:
          type: number
          example: 1
        limit:
          type: number
          example: 10
        total:
          type: number
          example: 24
        totalPages:
          type: number
          example: 3
        hasMore:
          type: boolean
          example: true
      required:
        - page
        - limit
        - total
        - totalPages
        - hasMore
      description: Standard list pagination metadata
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Obtain from your Pods dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.