onramps

Create Bank Onramp Account

Changed on

Create reusable bank deposit instructions. Each incoming transfer is recorded as a separate deposit, and the required deposit message must be included with every transfer.

post/onramp/bank/accounts

Request

Headers

X-API-KEYstring required

API key for authentication

Idempotency-Keystring required

Required client-generated key. Retrying the same request returns the originally created API key and secret. Reusing it with a different payload returns 409. Maximum 255 characters.

Request body

source_currency'usd' | 'eur' | 'mxn' | 'brl' | 'gbp' | 'cop' required

Fiat currency used by Bridge bank accounts and durable bank-onramp sessions

payment_rail'wire' | 'ach_push' | 'sepa' | 'spei' | 'pix' | 'faster_payments' | 'bre_b'

Fiat payment rail used to fund a reusable bank-onramp account

Example request

{
  "destination": {
    "currency": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001
    },
    "wallet_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
  },
  "payment_rail": "wire",
  "source_currency": "usd"
}

Response

Idempotent replay

idstring required
status'pending' | 'activated' | 'deactivated' required

Lifecycle of reusable bank deposit instructions

source_currency'usd' | 'eur' | 'mxn' | 'brl' | 'gbp' | 'cop' required

Fiat currency used by Bridge bank accounts and durable bank-onramp sessions

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "created_at": "2026-08-25T18:30:00Z",
  "deposit_instructions": {
    "account_holder_name": "CoinVoyage Customer",
    "account_number": "1234567890",
    "bank_address": "1801 Main Street, Kansas City, MO 64108",
    "bank_beneficiary_address": "111 E 5th Avenue, San Mateo, CA 94401",
    "bank_beneficiary_name": "Bridge Ventures Inc.",
    "bank_name": "Lead Bank",
    "bic": "COBADEFFXXX",
    "br_code": "00020126580014br.gov.bcb.pix0136example-key",
    "bre_b_key": "CV123456789",
    "clabe": "646180157034181180",
    "currency": "usd",
    "deposit_message": "CV-123456",
    "iban": "DE89370400440532013000",
    "payment_rails": [
      "wire",
      "ach_push"
    ],
    "routing_number": "021000021",
    "sort_code": "123456"
  },
  "destination": {
    "currency": {
      "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
      "chain_id": 30000000000001
    },
    "wallet_address": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"
  },
  "id": "onramp_account_123",
  "source_currency": "usd",
  "status": "activated",
  "updated_at": "2026-08-25T18:30:05Z"
}

Changes

    • warning

      added the new 20000000000002.00 enum value to the // response property for the response status

    • warning

      added the new 20000000000002.00 enum value to the // response property for the response status

    • info

      added the new 20000000000002.00 enum value to the request property //

    • info

      added the new bre_b enum value to the request property

    • info

      added the new faster_payments enum value to the request property