Get Onramp Transfer

Get All Onramp Transfers

get

https://api.alignlabs.devhttps://api-sandbox.alignlabs.dev

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

Path parameters

customer_idstringRequired

The unique identifier of the customer

Query parameters

limitinteger · min: 1 · max: 100Optional

Maximum number of records to return

skipintegerOptional

Number of records to skip

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

Successful retrieval of onramp transfers list

application/json

get

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

HTTPcURLJavaScriptPython

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

200

Successful retrieval of onramp transfers list

{
  "items": [
    {
      "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"
      }
    }
  ]
}

Get Onramp Transfer

get

https://api.alignlabs.devhttps://api-sandbox.alignlabs.dev

/v0/customers/{customer_id}/onramp-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 onramp transfer 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

get

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

HTTPcURLJavaScriptPython

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

200

Get onramp transfer response

{
  "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",
  "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"
  }
}