Create Offramp Transfer
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 · decimalRequiredExample:
The destination amount of the offramp transfer as a numeric string.
100.50
Pattern: ^[0-9]+(\.[0-9]+)?$
source_tokenstring · enumRequiredExample:
The currency to be deposited
usdc
Possible values: source_networkstring · enumRequiredExample:
The blockchain network for the source token
polygon
Possible values: destination_currencystring · enumRequiredExample:
The currency for the destination
usd
Possible values: destination_payment_railsstring · enumRequiredExample:
The rails type to be used for the bank transfer
ach
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: 488
{
"amount": "100.50",
"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": "processing",
"amount": "100.50",
"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": "0x1234567890abcdef1234567890abcdef12345678",
"deposit_amount": "100.50",
"fee_amount": "2.50"
}
}
Last updated