Create Onramp Transfer

Create new Onramp Transfer

Creates onramp transfer and returns deposit information

post

/v0/customers/{customer_id}/onramp-transfer

Path parameters

customer_idstringrequired

The unique identifier of the customer

Header parameters

Authorizationstringrequired

Token for authentication

Body

amountstring · decimalrequired

The amount of the onramp transfer as a numeric string

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

destination_addressstringrequired

The blockchain address where the funds will be sent

source_currencystring · enumrequired

The currency to be deposited

Options: usd, eur, mxn, ars, brl

source_railsstring · enumrequired

The deposit rails to be used for the transaction

Options: swift, ach, sepa, wire

destination_networkstring · enumrequired

The blockchain network for the destination

Options: polygon, ethereum, tron, solana

destination_tokenstring · enumrequired

The token for the destination

Options: usdc, usdt, eurc

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.alignlabs.dev/v0/customers/{customer_id}/onramp-transfer' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"amount":"text","destination_address":"text","source_currency":"usd","source_rails":"swift","destination_network":"polygon","destination_token":"usdc"}'

201

201

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

Successful onramp transfer initiation response