Create Onramp Transfer

Create new Onramp Transfer

Creates onramp request and returns deposit information

POSThttps://api.alignlabs.dev/v0/customers/{customer_id}/onramp-transfer

Path parameters

customer_id*string

The unique identifier of the customer

Header parameters

Body

application/json

amount*string (decimal)

The amount of the onramp transfer as a numeric string

Pattern: ^[0-9]+(\.[0-9]+)?$

source_currency*enum

The currency to be deposited

usdeurmxnarsbrl

source_rails*enum

The deposit rails to be used for the transaction

swiftachsepawire

destination_network*enum

The blockchain network for the destination

polygonethereumtronsolana

destination_token*enum

The token for the destination

usdcusdt

destination_address*string

The blockchain address where the funds will be sent

Response

201

Successful onramp transfer initiation response

Body

application/json

idstring (uuid)

The unique identifier for the onramp transfer

statusenum

The current status of the onramp transfer

pendingprocessingcompleted

amountstring (decimal)

The amount of the onramp transfer as a numeric string

Pattern: ^[0-9]+(\.[0-9]+)?$

source_currencyenum

The currency to be deposited

usdeurmxnarsbrl

source_railsenum

The deposit rails to be used for the transaction

swiftachsepawire

destination_networkenum

The blockchain network for the destination

polygonethereumtronsolana

destination_tokenenum

The token for the destination

usdcusdt

destination_addressstring

The blockchain address where the funds will be sent

quoteobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.alignlabs.dev/v0/customers/{customer_id}/onramp-transfer', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": "text",
      "source_currency": "usd",
      "source_rails": "swift",
      "destination_network": "polygon",
      "destination_token": "usdc",
      "destination_address": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "amount": "text",
  "source_currency": "usd",
  "source_rails": "swift",
  "destination_network": "polygon",
  "destination_token": "usdc",
  "destination_address": "text",
  "quote": {
    "deposit_rails": "swift",
    "deposit_currency": "usd",
    "deposit_bank_account": {
      "bank_name": "text",
      "bank_address": "text",
      "account_beneficiary_type": "individual",
      "account_beneficiary_name": "text",
      "account_beneficiary_address": "text",
      "account_type": "us"
    },
    "deposit_amount": "text",
    "deposit_message": "text",
    "fee_amount": "text"
  }
}