Skip to content
Codex

On-Ramp

Prerequisites

  1. Onboard an identity to the desired ramp provider.
    Currently, this step is manual — please contact us for assistance with provider onboarding.
    The onboarding process will also involve us creating a Codex-managed, self-custodied wallet on behalf of the identity.

    • Once onboarded, the provider will be available via the
      GET /providers endpoint.

  2. Verify wallet provisioning.
    Query the
    GET /wallets
    endpoint to confirm wallets have been provisioned for the identity.

  3. Check supported currency pairs.
    Use the
    GET /supported-pairs
    endpoint to ensure the desired currency pair is supported.

Steps

  1. Get fiat deposit instructions
    Retrieve them from the
    POST /deposits
    endpoint.

  2. Deposit fiat
    Send fiat to the account specified in the deposit instructions.

  3. Confirm fiat balance credit
    Query the provider’s /balances endpoint to check that your fiat balance has been credited.

    • The time for fiat to appear may vary based on geography and payment rails.
      Please contact us for a detailed list of expected settlement times.
    • We recommend polling the balances endpoint to verify your deposits have been received by the provider.

  4. Initiate the on-ramp transaction
    Call the
    POST /on-ramp
    endpoint with the source and destination currencies.

  5. Monitor transaction completion
    Choose one of the following methods:

Case Studies

Collections for Individual Customers

This implementation is ideal for organizations looking to allow their customers to collect fiat in the U.S. via Fedwire, SWIFT, and ACH, and then on-ramp the funds into their own segregated crypto wallets.

Flow diagram

Steps

  1. Fiat Collection and Balance Accumulation

    • The customer sends USD to their account with the provider.
    • Funds accumulate in the customer’s fiat account.

  2. Create Instant Transactions

    • Create multiple on-ramp transactions per customer, sourced from their respective fiat accounts.

    • Stablecoins will be credited to each customer’s Codex-provisioned self-custody wallet.

    • Monitor transaction status using the
      GET /transactions/{id}
      endpoint, or by subscribing to the ON_RAMP_TRANSACTION_COMPLETED and
      ON_RAMP_TRANSACTION_FAILED webhook events.

  3. Easy Access to Stables

    • The on-ramped stablecoins will reside in the Codex-provisioned wallet.
    • Users can transfer their crypto using the
      POST /crypto-transfers
      endpoint — for example, to perform an offramp for payout (see the relevant guide
      here) or to transfer the funds into another exchange for trading.