Align API
  • Overview
    • About
    • Features & Use Cases
    • Blockchains
    • Countries & Currencies
    • Compliance
  • PRODUCTS
    • Cross-Chain Stablecoin Transfers
    • Cross-Chain Stablecoin Deposits
    • Fiat To Stablecoin (On-Ramp)
    • Stablecoin To Fiat (Off-Ramp)
    • Yield Generating Stablecoins
  • Align API
    • Customers
      • Create Customer
      • Get Customer
      • Fetch Customers
      • Create KYC Session
      • Share Individual KYC
    • Cross Chain Transfers
      • [Create] Cross-Chain Transfer
      • [Complete] Cross-Chain Transfer
      • [Get] Cross-Chain Transfer
      • [Create] Permanent Route Address
      • [Get] Permanent Route Address
      • [List] Permanent Route Addresses
    • Offramp Transfers
      • Create Offramp Transfer
      • Complete Offramp Transfer
      • Get Offramp Transfer
    • Onramp Transfers
      • Create Onramp Transfer
      • Get Onramp Transfer
    • Developer
      • Get Developer Fees
      • Update Developer Fees
    • Files
      • Upload File
    • Virtual Accounts
      • Create Virtual Account
      • Get Virtual Account
      • Get All Virtual Accounts
  • FEes
    • Developer Fees
    • Align Fees
  • Legal
    • Terms & Conditions
    • Privacy Policy
  • Guides
    • Create customer
Powered by GitBook
On this page
  1. Align API
  2. Onramp Transfers

Get Onramp Transfer

PreviousCreate Onramp TransferNextDeveloper

Last updated 1 month ago

Get Onramp Transfer

get
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
200
Get onramp transfer response
application/json
get
GET /v0/customers/{customer_id}/onramp-transfer/{transfer_id} HTTP/1.1
Host: api.alignlabs.dev
Authorization: text
Accept: */*
200

Get onramp transfer 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"
  }
}