Create Onramp

Create Onramp

Creates onramp request and returns deposit information

POSThttps://api.getfractal.xyz/v0/customers/{customerId}/onramp

Path parameters

customerId*string

The unique identifier of the customer

Header parameters

Body

application/json

depositCurrency*enum

The currency to be deposited

usdeur

depositRails*enum

The deposit rails to be used for the transaction

swiftachsepawire

onramps*array of object

Array of onramp options

Response

201

Successful onramp transaction initiation response

Body

application/json

onrampTransactionIdstring

depositInfoobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.getfractal.xyz/v0/customers/{customerId}/onramp', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "depositCurrency": "usd",
      "depositRails": "swift",
      "onramps": [
        {
          "destinationChain": "polygon",
          "destinationCurrency": "usdc",
          "destinationAmount": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

201

{
  "onrampTransactionId": "text",
  "depositInfo": {
    "depositRails": "swift",
    "depositCurrency": "usd",
    "depositBankAccount": {
      "bankName": "text",
      "bankAddress": "text",
      "beneficiaryType": "individual",
      "beneficiaryName": "text",
      "beneficiaryAddress": "text",
      "currency": "usd",
      "rails": "swift"
    },
    "depositAmount": "text",
    "depositRef": "text",
    "feeAmount": "text"
  }
}