Create Offramp Transfer

Create new Offramp Transfer

Creates offramp transfer and returns deposit information

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

Path parameters

customer_id*string

The unique identifier of the customer

Header parameters

Body

application/json

amount*string (decimal)

The amount of the offramp transfer as a numeric string

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

source_token*enum

The currency to be deposited

usdcusdt

source_network*enum

The blockchain network for the source token

polygonethereumtronsolana

destination_currency*enum

The currency for the destination

usdeurmxnarsbrl

destination_bank_account*object

IBAN Account DetailsUS Account Details

Response

201

Successful offramp transfer initiation response

Body

application/json

idstring (uuid)

The unique identifier for the offramp transfer

statusenum

The current status of the offramp transfer

pendingprocessingcompleted

amountstring (decimal)

The amount of the offramp transfer as a numeric string

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

source_tokenenum

The currency to be deposited

usdcusdt

source_networkenum

The blockchain network for the source token

polygonethereumtronsolana

destination_currencyenum

The currency for the destination

usdeurmxnarsbrl

destination_bank_accountobject

IBAN Account DetailsUS Account Details

quoteobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.alignlabs.dev/v0/customers/{customer_id}/offramp-transfer', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": "text",
      "source_token": "usdc",
      "source_network": "polygon",
      "destination_currency": "usd",
      "destination_bank_account": {}
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "amount": "text",
  "source_token": "usdc",
  "source_network": "polygon",
  "destination_currency": "usd",
  "destination_bank_account": {
    "bank_name": "text",
    "bank_address": "text",
    "account_beneficiary_type": "individual",
    "account_beneficiary_name": "text",
    "account_beneficiary_address": "text",
    "account_type": "us"
  },
  "quote": {
    "deposit_network": "polygon",
    "deposit_token": "usdc",
    "deposit_blockchain_address": "text",
    "deposit_amount": "text",
    "fee_amount": "text"
  }
}