Get Offramp Transfer

Get Offramp Transfer

get

/v0/customers/{customer_id}/offramp-transfer/{transfer_id}

Path parameters

transfer_idstring · uuidRequired

The unique identifier of the cross-chain transfer

customer_idstring · uuidRequired

The unique identifier of the customer

Header parameters

Api-KeystringRequired

Your secret API key, available in the developer dashboard. Include this header on every request to authenticate your application.

Responses

200

Get offramp transfer response

application/json

idstring · uuidOptional

The unique identifier for the offramp transfer

statusstring · enumOptional

The current status of the offramp transfer

Example: processingPossible values:

amountstring · decimalOptional

The destination amount of the offramp transfer as a numeric string.

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

source_tokenstring · enumOptional

The currency to be deposited

Example: usdcPossible values:

source_networkstring · enumOptional

The blockchain network for the source token

Example: polygonPossible values:

destination_currencystring · enumOptional

The currency for the destination

Example: usdPossible values:

destination_payment_railsstring · enumOptional

The rails type to be used for the bank transfer

Example: achPossible values:

transfer_purposestring · enumOptional

The purpose of the transfer

Possible values:

payment_referencestring · max: 35Optional

Free-text reference sent with the payment. Max 35 characters.

Example: Invoice 12345

destination_bank_accountone ofOptional

or

or

get/v0/customers/{customer_id}/offramp-transfer/{transfer_id}

GET /v0/customers/{customer_id}/offramp-transfer/{transfer_id} HTTP/1.1
Host: api.alignlabs.dev
Api-Key: text
Accept: */*

200

Get offramp transfer response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "processing",
  "amount": "100.50",
  "source_token": "usdc",
  "source_network": "polygon",
  "destination_currency": "usd",
  "destination_payment_rails": "ach",
  "transfer_purpose": "charity",
  "payment_reference": "Invoice 12345",
  "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": "US",
      "city": "San Francisco",
      "street_line_1": "580 Howard, Suite PH San Francisco",
      "postal_code": "94105"
    },
    "account_type": "iban",
    "iban": {
      "bic": "text",
      "iban_number": "text"
    }
  },
  "quote": {
    "deposit_network": "polygon",
    "deposit_token": "usdc",
    "deposit_blockchain_address": "0x1234567890abcdef1234567890abcdef12345678",
    "deposit_amount": "100.50",
    "source_amount": "100.50",
    "destination_amount": "98.00",
    "exchange_rate": "0.98",
    "fee_amount": "2.50",
    "deposit_transaction_hash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
  }
}