v1

latestOpenAPI 3.0.02026-07-14664396.8 KB

ONRAMP

Create Onramp Transaction

Creates a new onramp transaction that converts fiat into crypto for the provided deposit address.

post/onramp

Headers

api-keystring

Example:alfredpay.T+QdhCoMofy8.gGKO5KdB7M+B/9jLFef

API Key for service authentication (alternative to JWT Bearer token). Optional.

api-secretstring

Example:PwF+cDGZd37eHYZ.CVvF1/zbHCBosSo1

API Secret for service authentication (alternative to JWT Bearer token). Optional.

Request body

customerIdstring required

Customer unique identifier (UUID)

quoteIdstring required

Quote unique identifier (UUID)

fromCurrency'BRL' | 'ARS' | 'MXN' | 'COP' | 'DOP' | 'GTQ' | 'CLP' | 'HK_USD' | 'HKD' | 'USD' | 'CNY' required

Source currency

toCurrency'USDC' | 'USDT' required

Target currency

amountstring required

Amount to be transacted

chain'MATIC' | 'ETH' | 'XLM' | 'TRX' | 'SOL' | 'CELO' | 'AVAX' | 'BNB'

Blockchain network

paymentMethodType'BANK' required

Payment method type

depositAddressstring

Deposit address for the transaction

externalIdstring

External identifier

memostring

Memo or reference for the transaction

metadataobject

Example request

{
  "customerId": "b1a2c3d4-e5f6-7890-abcd-1234567890ef",
  "quoteId": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
  "fromCurrency": "BRL",
  "toCurrency": "USDC",
  "amount": "100.00",
  "chain": "ETH",
  "paymentMethodType": "BANK",
  "depositAddress": "0xabc123..."
}