Create Offramp Transfer

Create new Offramp Transfer

post

Creates offramp transfer and returns deposit information

Path parameters

customer_idstringrequired

The unique identifier of the customer

Header parameters

Authorizationstringrequired

Token for authentication

Body

amountstring · decimalrequired

The amount of the offramp transfer as a numeric string

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

source_tokenstring · enumrequired

The currency to be deposited

Available options:

source_networkstring · enumrequired

The blockchain network for the source token

Available options:

destination_currencystring · enumrequired

The currency for the destination

Available options:

destination_payment_railsstring · enumrequired

The rails type to be used for the bank transfer

Available options:

destination_bank_accountone ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.alignlabs.dev/v0/customers/{customer_id}/offramp-transfer' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": "text",
    "source_token": "usdc",
    "source_network": "polygon",
    "destination_currency": "usd",
    "destination_payment_rails": "ach",
    "destination_bank_account": {
      "bank_name": "text",
      "account_holder_type": "individual",
      "account_holder_first_name": "text",
      "account_holder_last_name": "text",
      "account_holder_business_name": "text",
      "account_holder_address": {
        "country": "text",
        "city": "text",
        "street_line_1": "text",
        "postal_code": "text"
      },
      "account_type": "iban",
      "iban": {
        "bic": "text",
        "iban_number": "text"
      }
    }
  }'

201

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",
    "account_holder_type": "individual",
    "account_holder_first_name": "text",
    "account_holder_last_name": "text",
    "account_holder_business_name": "text",
    "account_type": "iban",
    "iban": {
      "bic": "text",
      "iban_number": "text"
    }
  },
  "quote": {
    "deposit_network": "polygon",
    "deposit_token": "usdc",
    "deposit_blockchain_address": "text",
    "deposit_amount": "text",
    "fee_amount": "text"
  }
}

Successful offramp transfer initiation response

Fallback Docs:

POST /v0/customers/{customer_id}/offramp-transfer

Create new Offramp Transfer

Headers

Name	Value
Content-Type	application/json
Authorization	<token>

Body

Name	Type	Description
amount	string	The amount of the offramp transfer as a numeric string
source_token	string 'usdc' | 'usdt' | 'eurc'	The currency to be deposited
source_network	string 'polygon' | 'ethereum' | 'tron' | 'solana'	The blockchain network for the source token
destination_currency	string 'usd' | 'eur'	The currency for the destination
destination_payment_rails	string 'wire' | 'ach' | 'sepa'	The rails type to be used for the bank transfer
destination_bank_account	object type destination_bank_account = { bank_name: string; account_holder_type: 'individual' | 'business'; account_holder_first_name?: string; account_holder_last_name?: string; account_holder_business_name?: string; account_holder_address: { country: string; // Two-letter ISO 3166-1 alpha-2 country code city: string; street_line_1: string; postal_code: string; }; account_type: 'us' | 'iban'; iban?: { bic: string; iban_number: string; }; us?: { account_number: string; routing_number: string; }; };

Response

200

type Response = {
  id: string;
  status: 'pending' | 'processing' | 'completed';
  amount: string;
  source_token: 'usdc' | 'usdt';
  source_network: 'polygon' | 'ethereum' | 'tron' | 'solana';
  destination_currency: 'usd' | 'eur' | 'mxn' | 'ars' | 'brl' | 'cny' | 'hkd' | 'sgd';
  destination_bank_account: {
    bank_name: string;
    account_holder_type: 'individual' | 'business';
    account_holder_first_name?: string;
    account_holder_last_name?: string;
    account_holder_business_name?: string;
    account_holder_address: {
      country: string;  // Two-letter ISO 3166-1 alpha-2 country code
      city: string;
      street_line_1: string;
      postal_code: string;
    };
    account_type: 'us' | 'iban';
    iban?: {
      bic: string;
      iban_number: string;
    };
    us?: {
      account_number: string;
      routing_number: string;
    };
  };
  quote: {
    deposit_network: 'polygon' | 'ethereum' | 'tron' | 'solana';
    deposit_token: 'usdc' | 'usdt' | 'eurc';
    deposit_blockchain_address: string;
    deposit_amount: string;
    fee_amount: string;
  };
};

400

{
  "error": "Invalid request"
}