Fractal API
  • Overview
    • About
    • Features & Use Cases
    • Blockchains
    • Countries & Currencies
    • Compliance
  • PRODUCTS
    • Cross-Chain Stablecoin Transfers
    • Cross-Chain Stablecoin Deposits
    • Fiat To Stablecoin (On-Ramp)
    • Stablecoin To Fiat (Off-Ramp)
    • Yield Generating Stablecoins
  • Fractal API
    • Customers
      • Create Customer
      • Get Customer
      • Fetch Customers
      • Create KYC Session
      • Share Individual KYC
    • Cross Chain Transfers
      • [Create] Cross-Chain Transfer
      • [Complete] Cross-Chain Transfer
      • [Get] Cross-Chain Transfer
      • [Create] Permanent Route Address
      • [Get] Permanent Route Address
      • [List] Permanent Route Addresses
    • Onramp
      • Create Onramp
    • Files
      • Upload File
  • FEes
    • Developer Fees
    • Fractal Fees
  • Legal
    • Terms & Conditions
    • Privacy Policy
Powered by GitBook
On this page
  1. Fractal API
  2. Onramp

Create Onramp

PreviousOnrampNextFiles

Last updated 8 months ago

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

Possible values:
depositRailsstring · enumRequired

The deposit rails to be used for the transaction

Possible values:
Responses
201
Successful onramp transaction initiation response
application/json
post
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"
  }
}