Create Offramp Transfer
Creates offramp transfer and returns deposit information
The unique identifier of the customer
Token for authentication
The amount of the offramp transfer as a numeric string
^[0-9]+(\.[0-9]+)?$
The currency to be deposited
The blockchain network for the source token
The currency for the destination
The rails type to be used for the bank transfer
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"
}
}
}
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"
}
}
Fallback Docs:
POST
/v0/customers/{customer_id}/offramp-transfer
Create new Offramp Transfer
Headers
Content-Type
application/json
Authorization
<token>
Body
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
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;
};
};
Last updated