> ## Documentation Index > Fetch the complete documentation index at: https://docs.ripio.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Fiat Account Requirements > Retrieves the specific payment details required for creating Fiat Accounts based on a payment method. ## OpenAPI ````yaml ramps-api/openapi.json GET /api/v1/fiatAccounts/requirements/ openapi: 3.1.0 info: title: Ripio Ramp API version: v1 description: >- API for Ripio ramp services, enabling partners to integrate On-Ramp, Off-Ramp, customer management, KYC processes, and other financial functionalities. This API is RESTful, uses JSON for requests and responses, and standard HTTP status codes. This document is based on the 'onramp-api.pdf' provided and aims to be compliant with OpenAPI Specification v3.1.0. The PDF indicates that the API documentation is a draft and subject to change. servers: - url: https://skala-sandbox.ripio.com description: Sandbox environment - url: https://skala.ripio.com description: Production environment security: - BearerToken: [] tags: - name: Authentication description: Operations related to API authentication and authorization. - name: Support Tickets description: >- Operations for raising and tracking customer support tickets with Ripio's support team. This feature must be enabled for your account by the Ripio team. - name: Customers description: Operations related to customer management. - name: KYC description: Operations related to Know Your Customer processes. - name: Investor Profile description: >- Brazilian accounts only: the investor-profile (suitability) questionnaire required by Resolução BCB nº 520/2025. - name: Fiat Accounts description: Operations related to managing fiat accounts and their requirements. - name: Quotes description: Operations related to obtaining and managing conversion quotes. - name: On-Ramp description: Operations related to fiat-to-crypto (on-ramp) processes. - name: Off-Ramp description: Operations related to crypto-to-fiat (off-ramp) processes. - name: Refunds description: >- Operations for returning the money of an on-ramp or off-ramp operation that could not be completed. Each ramp must be enabled for your account by the Ripio team. - name: Transactions description: Operations related to listing and managing all transaction types. - name: Networks description: >- Operations related to retrieving available deposit and withdrawal networks. - name: Rates description: Operations related to retrieving market rates. - name: Transaction Limits description: >- Operations related to retrieving per-transaction limits by currency and ramp operation. - name: Sandbox description: Operations specific to the sandbox environment for testing purposes. - name: Webhooks description: Webhook event notifications from Ripio Ramp API. - name: Sell and Pay description: >- Endpoints for managing Sell and Pay transactions, which allow customers to convert cryptocurrency to fiat currency and pay merchants via QR codes paths: /api/v1/fiatAccounts/requirements/: get: tags: - Fiat Accounts summary: Retrieve Fiat Account Requirements description: >- Retrieves the specific payment details required for creating Fiat Accounts based on a payment method. operationId: getFiatAccountRequirements parameters: - name: paymentMethodType in: query description: >- The payment method for which to retrieve requirements (e.g., `bank_transfer`). required: true schema: type: string responses: '200': description: Successfully retrieved fiat account requirements. content: application/json: schema: $ref: '#/components/schemas/FiatAccountRequirementsResponse' examples: Argentina: summary: Argentina - CVU/Alias Requirements value: - fieldName: alias_or_cvu_destination required: true type: TEXT Mexico: summary: Mexico - CLABE Requirements value: - fieldName: clabe_destination required: true type: TEXT Colombia - BREB: summary: Colombia - BREB Requirements value: - fieldName: key_value required: true type: TEXT Colombia - Bank Transfer: summary: Colombia - Bank Transfer Requirements description: >- Use GET /api/v1/banks/ to retrieve valid beneficiary_institution codes and their allowed counterparty_types. value: - fieldName: counterparty_type required: true type: CHOICE choices: - value: cc label: Cuenta corriente - value: ch label: Cuenta de ahorro - value: dp label: Depósito - fieldName: counterparty_fullname required: true type: TEXT - fieldName: counterparty_id_type required: true type: CHOICE choices: - value: cc label: Cédula de ciudadanía - value: nit label: NIT - value: ce label: Cédula de extranjería - fieldName: counterparty_id_number required: true type: TEXT - fieldName: beneficiary_institution required: true type: TEXT - fieldName: account_number required: true type: TEXT Brazil - PIX: summary: Brazil - PIX Requirements description: >- PIX withdrawal account. A single field: the PIX key, which may be a CPF, CNPJ, email, phone or EVP (random) key, up to 77 characters. The key type is inferred from the value and the account holder's name and document are resolved from the key itself, so neither is collected here — which is why each type must arrive in its canonical format: CPF as 11 bare digits, CNPJ as 14 bare digits, email as a plain address, EVP as a UUID, and a phone number in international format with the `+` and the country code (`+5511987654321`). A phone key sent as bare digits is rejected with a 400. value: - fieldName: pix_key required: true type: TEXT '400': description: Bad Request - e.g., missing or invalid `paymentMethodType`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingParameter: summary: paymentMethodType not sent value: code: 20000 type: ValidationError detail: - message: 'Missing query parameter: paymentMethodType' code: invalid status: 400 invalidPaymentMethodType: summary: paymentMethodType not available for the account's country value: code: 20000 type: ValidationError detail: - message: Payment method 'unknown_method' is not a valid option code: invalid status: 400 '401': description: Unauthorized - Invalid or missing access token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 40001 type: NotAuthenticated detail: message: Authentication credentials were not provided. code: not_authenticated status: 401 components: schemas: FiatAccountRequirementsResponse: type: array items: $ref: '#/components/schemas/FiatAccountRequirementField' ErrorResponse: type: object properties: code: type: integer description: Application-specific error code. type: type: string description: Type of error or exception. detail: type: - object - array description: >- Error details. The shape depends on the error: - Most business errors return an object with a `message` key. - Field validation errors return an object keyed by field name, each holding an array of `{ message, code }`. - Request-level validation errors (e.g. a missing query parameter) return a bare array of `{ message, code }`. properties: message: type: string description: Detailed error message. additionalProperties: true status: type: integer description: HTTP status code. required: - code - type - detail - status FiatAccountRequirementField: type: object properties: fieldName: type: string description: The technical name of the required field used within the API. required: type: boolean description: Indicates whether the field is mandatory (true) or optional (false). type: type: string description: The data type expected for the field value (e.g., TEXT, NUMBER). required: - fieldName - required - type securitySchemes: BearerToken: type: http scheme: bearer bearerFormat: JWT description: >- Access token obtained via [/oauth2/token/](/ramps-api/authentication/acquire-access-token). Use as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.