Align 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
  • Align 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
    • Offramp Transfers
      • Create Offramp Transfer
      • Complete Offramp Transfer
      • Get Offramp Transfer
    • Onramp Transfers
      • Create Onramp Transfer
      • Get Onramp Transfer
    • Developer
      • Get Developer Fees
      • Update Developer Fees
    • Files
      • Upload File
    • Virtual Accounts
      • Create Virtual Account
      • Get Virtual Account
      • Get All Virtual Accounts
  • FEes
    • Developer Fees
    • Align Fees
  • Legal
    • Terms & Conditions
    • Privacy Policy
  • Guides
    • Create customer
Powered by GitBook
On this page
  1. Align API
  2. Offramp Transfers

Create Offramp Transfer

PreviousOfframp TransfersNextComplete Offramp Transfer

Last updated 2 months ago

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

The currency to be deposited

source_network

string

The blockchain network for the source token

destination_currency

string

The currency for the destination

destination_payment_rails

string

The rails type to be used for the bank transfer

destination_bank_account

object

Response

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;
  };
};
{
  "error": "Invalid request"
}

'usdc' | 'usdt' | 'eurc'
'polygon' | 'ethereum' | 'tron' | 'solana'
'usd' | 'eur'
'wire' | 'ach' | 'sepa'
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;
  };
};

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

Possible values:
source_networkstring · enumRequired

The blockchain network for the source token

Possible values:
destination_currencystring · enumRequired

The currency for the destination

Possible values:
destination_payment_railsstring · enumRequired

The rails type to be used for the bank transfer

Possible values:
destination_bank_accountone ofRequired
or
Responses
201
Successful offramp transfer initiation response
application/json
post
POST /v0/customers/{customer_id}/offramp-transfer HTTP/1.1
Host: api.alignlabs.dev
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 486

{
  "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

Successful offramp transfer initiation response

{
  "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"
  }
}