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

Authorizationstringrequired

Token for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.alignlabs.dev/v0/customers/{customer_id}/offramp-transfer/{transfer_id}' \
  --header 'Authorization: text'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "status": "pending",
  "source_token": "usdc",
  "source_network": "polygon",
  "destination_currency": "usd",
  "quote": {
    "deposit_blockchain_address": "text",
    "deposit_amount": "text",
    "fee_amount": "text",
    "deposit_network": "polygon",
    "deposit_token": "usdc"
  },
  "destination_bank_account": {
    "bank_name": "text",
    "account_holder_first_name": "text",
    "account_holder_last_name": "text",
    "account_holder_business_name": "text",
    "account_holder_type": "individual",
    "account_type": "iban",
    "iban": {
      "bic": "text",
      "iban_number": "text"
    }
  }
}

Get offramp transfer response

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

Get Offramp Transfer

Headers

Name	Value
Content-Type	application/json
Authorization	<token>

Response

200

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;
      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;
  };
};

400

{
  "error": "Invalid request"
}