Create Onramp

Create Onramp

post

Creates onramp request and returns deposit information

Path parameters

customerIdstringRequired

The unique identifier of the customer

Header parameters

AuthorizationstringRequired

Token for authentication

Body

depositCurrencystring · enumRequired

The currency to be deposited

Available options:

depositRailsstring · enumRequired

The deposit rails to be used for the transaction

Available options:

onrampsobject[]Required

Array of onramp options

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /v0/customers/{customerId}/onramp HTTP/1.1
Host: api.getfractal.xyz
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "depositCurrency": "usd",
  "depositRails": "swift",
  "onramps": [
    {
      "destinationAmount": "text",
      "destinationCurrency": "usdc",
      "destinationChain": "polygon",
      "destinationAddress": "text"
    }
  ]
}

201

Successful onramp transaction initiation response

{
  "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"
  }
}