v1

latestOpenAPI 3.1.02026-07-24320172.9 KB

Create a Ramp

post/api/ramp/v1/swaporder

Headers

Authorizationstring required

The personal authentication token obtained by each user from the token authentication endpoint

Request body

taxIdstring required

Field that uniquely identifies the individual or country. Only numbers accepted, all number should be sent, including leading zeros when applicable.

taxIdCountry'ALB' | 'AND' | 'ARE' | 'ARG' | 'ARM' | 'AUS' | 'AUT' | 'AZE' | 'BEL' | 'BGR' | 'BHR' | 'BIH' | 'BLR' | 'BOL' | 'BRA' | 'CAN' | 'CHE' | 'CHL' | 'CHN' | 'COL' | 'CRI' | 'CUB' | 'CYP' | 'CZE' | 'DEU' | 'DNK' | 'DOM' | 'ECU' | 'ESP' | 'EST' | 'FIN' | 'FLK' | 'FRA' | 'FRO' | 'GBR' | 'GEO' | 'GRC' | 'GTM' | 'GUF' | 'GUY' | 'HKG' | 'HRV' | 'HUN' | 'IDN' | 'IND' | 'IRL' | 'ISL' | 'ISR' | 'ITA' | 'JPN' | 'KAZ' | 'KOR' | 'LTU' | 'LUX' | 'LVA' | 'MCO' | 'MDA' | 'MEX' | 'MKD' | 'MLT' | 'MNE' | 'MUS' | 'MYS' | 'NGA' | 'NLD' | 'NOR' | 'NZL' | 'PAK' | 'PER' | 'PHL' | 'POL' | 'PRT' | 'PRY' | 'ROU' | 'RUS' | 'SLV' | 'SMR' | 'SRB' | 'SUR' | 'SVK' | 'SVN' | 'SWE' | 'THA' | 'TUR' | 'TWN' | 'UKR' | 'URY' | 'USA' | 'UZB' | 'VEN' | 'ZAF' required

The target country. It is obrigatory if param taxId is filled

externalIdstring

Field used for partner link a personal identifier

namestring

Holder's name

emailstring

Holder's email

quoteIdstring

Previously generated quote Id by using the Request a Quote endpoint. Mandatory if the quoteRequest is not filled

depositBlockchain'None' | 'Ethereum' | 'BinanceSmartChain' | 'Solana' | 'Stellar' | 'Ripple' | 'Bitcoin' | 'Polygon' | 'Avalanche' | 'Polkadot' | 'Fantom' | 'Cosmos' | 'Terra' | 'Tron' | 'Optimism' | 'Arbitrum' | 'Tezos' | 'Rootstock' | 'Moonbeam' | 'Injective' | 'Sui' | 'Aptos' | 'Celo' | 'Aurora' | 'Cronos' | 'Base' | 'ZkSync' | 'Linea' | 'Zeniq' | 'PolygonZkEVM' | 'Mantle' | 'TON' | 'BinancePay' | 'Gnosis' | 'Chiliz' | 'LightningNetwork'

Target deposit blockchain

refundCryptoAddressstring

Response

200

idstring
currencystring
blockchainstring
depositAmountnumber
referenceIdstring
expireAtstring
depositAddressstring
blockchainFeeinteger
walletAddressstring
base64QRCodestring

Example response

{
  "id": "b6a11cca-ef64-4292-8bbd-a78689bda16d",
  "currency": "BRL",
  "blockchain": "Bitcoin",
  "depositAmount": 101.1,
  "referenceId": "teste-reference01",
  "expireAt": "2020-07-30T18:00:00.000Z",
  "depositAddress": "pix-0123129442",
  "blockchainFee": 3,
  "walletAddress": "0xdasd15215w2344",
  "base64QRCode": "oijfvbgtrgoAAAANSUhEUgAAAW0AAAFtCAYAAADMATsiAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAADOvSURBVHhe7dTBjuxYki3Z+v+frq4EYrgG8rC1SfNICiC4E1HVQ4uA/8//fnx8fHz8Gb4/2h8fHx9/iO+P9sfHx8cf4vuj/fHx8fGH+P5of3x8fPwhvj/aHx8fH3+I74/2x8fHxx/i+6P98fHx8Yf4/mh/fHx8/CG+P9ofHx8ff4jvj/bHx8fHH+L7o/3x8fHxh/j+aH98fHz8Ib4/2h8fHx9/iO+P9sfHx8cf4vuj/fHx8fGH+P5of3x8fPwhvj/aHx8fH3+I74/2x8fHxx/i+6P98fHx8Yc4/6P9P//zPz+jUCcrmpWidk9Q36KuWtFsVaiTonbX6K4UtXuL+r7aCc2+5TXnG/XotxTqZEWzUtTuCepb1FUrmq0KdVLU7hrdlaJ2b1HfVzuh2be85nyjHv2WQp2saFaK2j1BfYu6akWzVaFOitpdo7tS1O4t6vtqJzT7ltecb9Sj31KokxXNSlG7J6hvUVetaLYq1ElRu2t0V4ravUV9X+2EZt/ymvONevRbCnWyolkpavcE9S3qqhXNVoU6KWp3je5KUbu3qO+rndDsW15zvvGJR4sn7i43rmcXhTop1FXFL3WLFc3KhbpPXbXyxGztrnni7vnGJx4tnri73LieXRTqpFBXFb/ULVY0KxfqPnXVyhOztbvmibvnG594tHji7nLjenZRqJNCXVX8UrdY0axcqPvUVStPzNbumifunm984tHiibvLjevZRaFOCnVV8UvdYkWzcqHuU1etPDFbu2ueuHu+8YlHiyfuLjeuZxeFOinUVcUvdYsVzcqFuk9dtfLEbO2ueeLu+cb6aHVVUbuK9knxF7uqWLprhbqqeKK7VtRuod74pa4qardwvrE+Wl1V1K6ifVL8xa4qlu5aoa4qnuiuFbVbqDd+qauK2i2cb6yPVlcVtatonxR/sauKpbtWqKuKJ7prRe0W6o1f6qqidgvnG+uj1VVF7SraJ8Vf7Kpi6a4V6qriie5aUbuFeuOXuqqo3cL5xvpodVVRu4r2SfEXu6pYumuFuqp4ortW1G6h3vilripqt3C+sT5aXVXU7prru9pXFbUTy2xFN6riiU5ec31D+6qVOquuWqmz6qqidgvnG+uj1VVF7a65vqt9VVE7scxWdKMqnujkNdc3tK9aqbPqqpU6q64qardwvrE+Wl1V1O6a67vaVxW1E8tsRTeq4olOXnN9Q/uqlTqrrlqps+qqonYL5xvro9VVRe2uub6rfVVRO7HMVnSjKp7o5DXXN7SvWqmz6qqVOquuKmq3cL6xPlpdVdTumuu72lcVtRPLbEU3quKJTl5zfUP7qpU6q65aqbPqqqJ2C+cb66PVVcXSVSualaJ2lWWfZq+taPYJF7TvLcVb3UK9sXRVUbuF84310eqqYumqFc1KUbvKsk+z11Y0+4QL2veW4q1uod5Yuqqo3cL5xvpodVWxdNWKZqWoXWXZp9lrK5p9wgXte0vxVrdQbyxdVdRu4XxjfbS6qli6akWzUtSusuzT7LUVzT7hgva9pXirW6g3lq4qardwvrE+Wl1VLF21olkpaldZ9mn22opmn3BB+95SvNUt1BtLVxW1Wzjf+MSjRb1bu4r2LV6z3Fhmr7l+i/ZdK5ZOVuqsuurCr++rPHH3fOMTjxb1bu0q2rd4zXJjmb3m+i3ad61YOlmps+qqC7++r/LE3fONTzxa1Lu1q2jf4jXLjWX2muu3aN+1Yulkpc6qqy78+r7KE3fPNz7xaFHv1q6ifYvXLDeW2Wuu36J914qlk5U6q6668Ov7Kk/cPd/4xKNFvVu7ivYtXrPcWGavuX6L9l0rlk5W6qy66sKv76s8cfd8ox79luLrvu4/fN1/X/eW15xv1KPfUnzd1/2Hr/vv697ymvONevRbiq/7uv/wdf993Vtec75Rj35L8XVf9x++7r+ve8trzjfq0W8pvu7r/sPX/fd1b3nN/cY/yBM/tNDd6jW6IRe0b3Gh7qudqLPqFoU6KWon3pr9N/P9Cv/HW/9z6G71Gt2QC9q3uFD31U7UWXWLQp0UtRNvzf6b+X6F/+Ot/zl0t3qNbsgF7VtcqPtqJ+qsukWhToraibdm/818v8L/8db/HLpbvUY35IL2LS7UfbUTdVbdolAnRe3EW7P/Zr5f4f94638O3a1eoxtyQfsWF+q+2ok6q25RqJOiduKt2X8zj/wK+vHfUtROvDW7sNyts+p+3SfQ3WpFs1Kok2LpFiualQvX+8T9RqAPeUtRO/HW7MJyt86q+3WfQHerFc1KoU6KpVusaFYuXO8T9xuBPuQtRe3EW7MLy906q+"
}