Create Onramp

Create Onramp

Creates onramp request and returns deposit information

post

/v0/customers/{customerId}/onramp

Path parameters

customerIdstringrequired

The unique identifier of the customer

Header parameters

Authorizationstringrequired

Token for authentication

Body

depositCurrencystring · enumrequired

The currency to be deposited

Options: usd, eur

depositRailsstring · enumrequired

The deposit rails to be used for the transaction

Options: swift, ach, sepa, wire

onrampsobject[]required

Array of onramp options

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getfractal.xyz/v0/customers/{customerId}/onramp' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "depositCurrency": "usd",
    "depositRails": "swift",
    "onramps": [
      {
        "destinationAmount": "text",
        "destinationCurrency": "usdc",
        "destinationChain": "polygon",
        "destinationAddress": "text"
      }
    ]
  }'

201

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

Successful onramp transaction initiation response