> ## 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. # Create On-Ramp Order > Initiates a fiat-to-crypto on-ramp transaction process based on a previously obtained quote. Returns transaction details and fiat payment instructions for the customer. ## OpenAPI ````yaml ramps-api/openapi.json POST /api/v1/onramp/ 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: 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: 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/onramp/: post: tags: - On-Ramp summary: Create On-Ramp Order description: >- Initiates a fiat-to-crypto on-ramp transaction process based on a previously obtained quote. Returns transaction details and fiat payment instructions for the customer. operationId: createOnRampOrder requestBody: required: true description: Details for creating an on-ramp order. content: application/json: schema: $ref: '#/components/schemas/OnRampOrderCreationRequest' responses: '201': description: On-Ramp order created successfully. content: application/json: schema: $ref: '#/components/schemas/OnRampOrderResponse' '400': description: Bad Request - e.g., invalid quoteId, customerId, or depositAddress. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '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 '404': description: >- Not Found - e.g., Customer not found or inactive, or Quote not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 40004 type: NotFound detail: message: Not found. code: not_found status: 404 components: schemas: OnRampOrderCreationRequest: type: object properties: customerId: type: string format: uuid description: Unique identifier for the customer. example: b6cecc1f-c90d-424b-adaa-c82b780696c1 quoteId: type: string format: uuid description: Unique identifier for the quote obtained from the Quoting Endpoint. example: 8142b065-79c4-4f48-9e33-11b17bc658d4 depositAddress: type: string description: The customer's deposit address on the chosen blockchain network. example: '0x4e88BBeFF059BDDF5BF90ee0816E86eDf4214b32' externalRef: type: string format: uuid description: >- Unique identifier for the order that is being created, provided by the partner. example: e6c4f1ec-899f-43b5-8479-c2529e3f9c70 extraData: type: object description: >- Additional data for the on-ramp order. Required for Colombia payment methods (`bank_transfer`, `r2p_bancolombia`, `r2p_nequi`). properties: callback: type: string format: uri description: >- Callback URL for payment notifications. Required for Colombia payment methods (`bank_transfer`, `r2p_bancolombia`, `r2p_nequi`). example: https://example.com/callback bankCode: type: string description: >- Bank code for Colombia `bank_transfer` payment method. Not required for `r2p_bancolombia` or `r2p_nequi`. Retrieve valid codes from `GET /api/v1/banks/`. example: '1001' required: - customerId - quoteId - depositAddress - externalRef OnRampOrderResponse: type: object properties: transaction: $ref: '#/components/schemas/OnRampTransactionDetail' fiatPaymentInstructions: type: object description: >- Instructions for the customer to complete the fiat deposit. Structure varies depending on payment method and currency: `bank_transfer` (Argentina) returns `cvu` and optionally `alias` (a human-readable identifier that can be used instead of the CVU for transfers — to enable alias customization, contact the Ripio team), `bank_transfer` (Mexico) returns `clabe`, `bank_transfer` (Colombia) returns `paymentUrl`, `breb` returns `brebKey`, `r2p_bancolombia` returns `paymentUrl`, `r2p_nequi` returns `phoneNumber`. Methods backed by a persistent deposit account (`cvu`, `clabe`, `brebKey`) also include a `status` field (`processing`, `enabled` or `disabled`) indicating whether the deposit account is ready to operate; while `processing`, the deposit key/identifier may be `null`. additionalProperties: true examples: - cvu: '0100000000000000000001' alias: juan.perez.ramp status: enabled - cvu: '0100000000000000000001' status: enabled - clabe: '706180196550550550' status: enabled - paymentUrl: https://example.com/payment/abc123 - brebKey: '@ABC123' status: enabled - phoneNumber: '*****1234' required: - transaction - fiatPaymentInstructions ErrorResponse: type: object properties: code: type: integer description: Application-specific error code. type: type: string description: Type of error or exception. detail: type: object properties: message: type: string description: Detailed error message. additionalProperties: true status: type: integer description: HTTP status code. required: - code - type - detail - status OnRampTransactionDetail: type: object description: Details of an on-ramp transaction. properties: transactionId: type: string format: uuid description: Unique identifier for the on-ramp transaction. example: 21d8a046-3221-4b43-a301-0f9adcdd9a45 createdAt: type: string format: date-time description: Date and time the on-ramp transaction was created. customerId: type: string format: uuid description: Customer's unique identifier. quoteId: type: string format: uuid description: Reference to the original quote used for this transaction. fromCurrency: type: string description: The source currency (fiat) used in the on-ramp transaction. example: ARS toCurrency: type: string description: The target cryptocurrency received in the on-ramp transaction. example: USDC amount: type: string description: >- The amount of the target cryptocurrency received (based on the original quote). chain: type: string description: The target blockchain network for the cryptocurrency deposit. example: ETHEREUM_SEPOLIA metadata: type: object description: Additional metadata associated with the transaction. additionalProperties: true example: {} txnHash: type: - string - 'null' description: >- Transaction hash for the on-chain operation (null if not yet processed). example: null paymentMethodType: type: string description: The payment method used for the fiat deposit. example: bank_transfer depositAddress: type: string description: The customer's deposit address on the target blockchain. status: type: string description: The current transaction status. enum: - ON_RAMP_DEPOSIT_RECEIVED - ON_RAMP_TRADE_COMPLETED - ON_RAMP_WITHDRAWAL_PROCESSING - ON_RAMP_WITHDRAWAL_COMPLETED - ON_RAMP_TRADE_CANCELLED - ON_RAMP_ORDER_EXPIRED - ON_RAMP_REFUND_COMPLETED example: WITHDRAWAL_PENDING externalRef: type: string format: uuid description: Unique identifier for the order provided by the partner. source: type: string description: Indicates the origin of the on-ramp order. enum: - ON_RAMP - ON_RAMP_SESSION example: ON_RAMP sender: type: - string - 'null' description: >- Name of the holder of the originating fiat account (e.g. CVU/CLABE owner). Null when not provided by the fiat provider. example: Juan Pérez required: - transactionId - createdAt - customerId - quoteId - fromCurrency - toCurrency - amount - chain - paymentMethodType - depositAddress - status - externalRef - source 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 `. ````