Create Onramp Transfer
Creates onramp transfer and returns deposit information
Path parameters
customer_idstringRequired
The unique identifier of the customer
Header parameters
AuthorizationstringRequired
Token for authentication
Body
amountstring · decimalRequiredPattern:
The amount of the onramp transfer as a numeric string
^[0-9]+(\.[0-9]+)?$
source_currencystring · enumRequiredPossible values:
The currency to be deposited
source_railsstring · enumRequiredPossible values:
The deposit rails to be used for the transaction
destination_networkstring · enumRequiredPossible values:
The blockchain network for the destination
destination_tokenstring · enumRequiredPossible values:
The token for the destination
destination_addressstringRequired
The blockchain address where the funds will be sent
Responses
201
Successful onramp transfer initiation response
application/json
post
POST /v0/customers/{customer_id}/onramp-transfer HTTP/1.1
Host: api.alignlabs.dev
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 152
{
"amount": "text",
"source_currency": "usd",
"source_rails": "swift",
"destination_network": "polygon",
"destination_token": "usdc",
"destination_address": "text"
}
201
Successful onramp transfer initiation response
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"amount": "text",
"source_currency": "usd",
"source_rails": "ach",
"destination_network": "polygon",
"destination_token": "usdc",
"destination_address": "text",
"quote": {
"deposit_rails": "ach",
"deposit_currency": "usd",
"deposit_bank_account": {
"bank_name": "text",
"bank_address": "text",
"account_beneficiary_type": "individual",
"account_beneficiary_name": "text",
"account_type": "us",
"iban": {
"bic": "text",
"iban_number": "text"
}
},
"deposit_amount": "text",
"deposit_message": "text",
"fee_amount": "text"
}
}
Last updated