Get Onramp Transfer

Method Signature

align.transfers.getOnrampTransfer(
  customerId: string,
  transferId: string
): Promise<Transfer>

Parameters

string

required

The unique customer identifier (UUID format)

string

required

The unique onramp transfer identifier

Returns

string

Unique transfer identifier

string

Current status: pending, processing, completed, failed

string

Transfer type: onramp

string

Amount of fiat sent

string

Amount of cryptocurrency received

Examples

TypeScript
JavaScript

import Align from "@tolbel/align";

const align = new Align({
  apiKey: process.env.ALIGN_API_KEY!,
  environment: "sandbox",
});

const transfer = await align.transfers.getOnrampTransfer(
  "123e4567-e89b-12d3-a456-426614174000",
  "tr_onramp_xyz789"
);

console.log(`Status: ${transfer.status}`);
console.log(`Sent: $${transfer.source_amount} USD`);
console.log(`Received: ${transfer.destination_amount} USDC`);

const transfer = await align.transfers.getOnrampTransfer(
  "123e4567-e89b-12d3-a456-426614174000",
  "tr_onramp_xyz789"
);

console.log("Status:", transfer.status);

Full Response Example

{
  "id": "tr_onramp_xyz789",
  "status": "completed",
  "type": "onramp",
  "source_amount": "100.00",
  "source_currency": "usd",
  "destination_amount": "98.50",
  "destination_token": "usdc",
  "destination_network": "polygon",
  "fee_amount": "1.50",
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:45:00Z"
}

Get Offramp Transfer

Get crypto-to-fiat transfer

List Onramp Transfers

List all onramp transfers

Getting Started

API Reference

Get Onramp Transfer

Method Signature

Parameters

Returns

Examples

Full Response Example

Get Offramp Transfer

List Onramp Transfers

​Method Signature

​Parameters

​Returns

​Examples

​Full Response Example

​Related Methods

Get Offramp Transfer

List Onramp Transfers

Method Signature

Parameters

Returns

Examples

Full Response Example

Related Methods