Skip to main content
POST
/
virtual-wallets
/
bank-ramps
/
ramp-on
curl -X POST "https://api.cryptomate.me/virtual-wallets/bank-ramps/ramp-on" \
  -H "x-api-key: $CRYPTOMATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_id": "vw_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "amount": 1000.00,
    "source_currency": "USD"
  }'

{
  "id": "rampon_abc123",
  "state": "pending",
  "amount": 1000.00,
  "currency": "USD",
  "payment_rail": "WIRE",
  "deposit_message": "REF123456",
  "bank_number": "123456789",
  "bank_code": "001",
  "bank_name": "Example Bank",
  "bank_address": "123 Main Street",
  "bank_beneficiary_name": "Cryptomate Technologies",
  "bank_beneficiary_address": "456 Beneficiary Ave",
  "br_code": null,
  "qr_code": null
}
Creates and executes a bank ramp-on transaction to deposit fiat currency into a crypto wallet. The response contains the bank details and reference required to complete the deposit. Requires an API key with access level 2 or higher.

​
Body

​
wallet_id
string
required
Virtual wallet identifier.
​
amount
number
required
Amount to deposit in fiat currency.
​
source_currency
string
required
Source fiat currency. One of USD, EUR, MXN, BRL, GBP, COP.
​
payment_rail
string
Payment rail. Required when source_currency is COP; ignored otherwise. One of co_bank_transfer, bre_b.
​
redirect_url
string
URL to redirect the user to after the PSE flow completes. Required when source_currency is COP and payment_rail is co_bank_transfer; ignored otherwise.

​
Response

​
id
string
Unique ramp-on operation identifier.
​
state
string
Current state of the operation.
​
amount
number
Amount to be deposited.
​
currency
string
Currency for the deposit. One of USD, EUR, MXN, BRL, GBP, COP.
​
payment_rail
string
Payment rail method. One of ACH, WIRE, SEPA, SPEI, PIX, FASTER_PAYMENTS, CO_BANK_TRANSFER, BRE_B.
​
deposit_message
string
Message/reference to include in the deposit.
​
bank_number
string
Bank account number.
​
bank_code
string
Bank code or routing number.
​
bank_name
string
Bank name.
​
bank_address
string
Bank address.
​
bank_beneficiary_name
string
Beneficiary name.
​
bank_beneficiary_address
string
Beneficiary address.
​
br_code
string
BR code for PIX payments (Brazil only).
​
qr_code
string
Base64-encoded QR code image for the deposit.
​
start_url
string
PSE checkout URL. Only present when payment_rail is CO_BANK_TRANSFER. Redirect the user here to authorize the payment with their bank.
​
redirect_url
string
Echo of the redirect_url sent in the request. Only present when payment_rail is CO_BANK_TRANSFER.
​
bre_b_key
string
Destination Bre-B key to display to the user. Only present when payment_rail is BRE_B.
curl -X POST "https://api.cryptomate.me/virtual-wallets/bank-ramps/ramp-on" \
  -H "x-api-key: $CRYPTOMATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "wallet_id": "vw_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "amount": 1000.00,
    "source_currency": "USD"
  }'

{
  "id": "rampon_abc123",
  "state": "pending",
  "amount": 1000.00,
  "currency": "USD",
  "payment_rail": "WIRE",
  "deposit_message": "REF123456",
  "bank_number": "123456789",
  "bank_code": "001",
  "bank_name": "Example Bank",
  "bank_address": "123 Main Street",
  "bank_beneficiary_name": "Cryptomate Technologies",
  "bank_beneficiary_address": "456 Beneficiary Ave",
  "br_code": null,
  "qr_code": null
}