Create Transfer From Quote

Create Onramp Transfer from Quote

post

/v0/customers/{customer_id}/onramp-transfer/quote/{quote_id}

Creates onramp transfer using an existing quote

Authorizations

Api-KeystringRequired

Path parameters

customer_idstring · uuidRequired

The unique identifier of the customer

quote_idstring · uuidRequired

The unique identifier of the quote

Body

destination_addressstringRequired

The blockchain address where the funds will be sent

Example: 0x742d35Cc6634C0532925a3b844Bc454e4438f44e

Responses

201

Successful onramp transfer initiation response

application/json

idstring · uuidOptional

The unique identifier for the onramp transfer

statusstring · enumOptional

The current status of the onramp transfer

Possible values:

amountstring · decimalOptional

The amount of the onramp transfer as a numeric string

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

source_currencystring · enumOptional

The currency to be deposited

Example: usdPossible values:

source_railsstring · enumOptional

The deposit rails to be used for the transaction

Example: achPossible values:

destination_networkstring · enumOptional

The blockchain network for the destination

Example: polygonPossible values:

destination_tokenstring · enumOptional

The token for the destination

Example: usdcPossible values:

destination_addressstringOptional

The blockchain address where the funds will be sent

Example: 0x742d35Cc6634C0532925a3b844Bc454e4438f44e

destination_tx_hashstringOptional

The blockchain transaction hash of the destination withdrawal

Example: 0xabc123def456abc123def456abc123def456abc123def456abc123def456abc1

400

The quote can no longer be used to create a transfer. Possible reasons:

• Quote has expired — the quote is past its expire_at window
• Quote has already been used for a transfer — the quote was already consumed
• Quote not found

application/json

post/v0/customers/{customer_id}/onramp-transfer/quote/{quote_id}

POST /v0/customers/{customer_id}/onramp-transfer/quote/{quote_id} HTTP/1.1
Host: api.alignlabs.dev
Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "destination_address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "amount": "1000.50",
  "source_currency": "usd",
  "source_rails": "ach",
  "destination_network": "polygon",
  "destination_token": "usdc",
  "destination_address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "destination_tx_hash": "0xabc123def456abc123def456abc123def456abc123def456abc123def456abc1",
  "quote": {
    "deposit_rails": "ach",
    "deposit_currency": "usd",
    "deposit_bank_account": {
      "bank_name": "Chase Bank",
      "bank_address": "270 Park Avenue, New York, NY 10017",
      "account_beneficiary_type": "business",
      "account_beneficiary_name": "Acme Corp",
      "account_type": "us",
      "iban": {
        "bic": "CHASUS33",
        "iban_number": "DE89370400440532013000"
      }
    },
    "deposit_amount": "1000.50",
    "deposit_message": "ONRAMP-REF-123456",
    "fee_amount": "10.50"
  },
  "received_deposit": {
    "remitter": {
      "name": "Acme Corp"
    },
    "payment_reference": "Invoice 4471"
  }
}