Quote Preflight (Balance Check)

GET

api

quotes

preflight

curl --request GET \
  --url https://api.teel.finance/api/quotes/preflight

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.teel.finance/api/quotes/preflight",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teel.finance/api/quotes/preflight"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teel.finance/api/quotes/preflight")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "ok": false,
  "required": "1500.000000",
  "requiredUnits": "1500000000",
  "available": "1200.500000",
  "availableUnits": "1200500000",
  "eoa": "0x1234abcd5678ef901234abcd5678ef901234abcd",
  "chainId": 137,
  "token": "USDC",
  "decimals": 6
}

A read-only check for payouts that start from stablecoin (stablecoin-to-fiat, stablecoin-to-stablecoin). Call it before executing to confirm the source wallet holds enough of the token on the right chain, so an insufficient balance surfaces up front instead of as a stranded payout. No state is changed.

Query parameters

string

required

Platform crypto ticker including chain suffix, e.g. USDCPOLYGON, USDCBASE. Determines the chain the balance is read on.

number

required

The amount needed, in display units (e.g. 1500.123456).

string

required

EVM wallet address (hex) to check the balance of.

Response

boolean

true when the wallet holds at least required. false is not an error — it means the wallet is short; use required vs available to render the gap.

string

Required amount, display units.

string

Required amount, raw token units (string-encoded big integer).

string

Wallet balance, display units.

string

Wallet balance, raw token units.

string

The wallet address checked (echoed back).

integer

Chain the balance was read on.

string

Token symbol (e.g. USDC).

integer

Token decimals.

{
  "ok": false,
  "required": "1500.000000",
  "requiredUnits": "1500000000",
  "available": "1200.500000",
  "availableUnits": "1200500000",
  "eoa": "0x1234abcd5678ef901234abcd5678ef901234abcd",
  "chainId": 137,
  "token": "USDC",
  "decimals": 6
}

Returns 503 with { "error": { "code": "preflight_unsupported" } } when the chain implied by cryptoTicker has no escrow client registered, and 400 (invalid_request / corridor_unsupported) for bad input.

Quote Preflight (Balance Check)

curl --request GET \
  --url https://api.teel.finance/api/quotes/preflight

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.teel.finance/api/quotes/preflight",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teel.finance/api/quotes/preflight"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teel.finance/api/quotes/preflight")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "ok": false,
  "required": "1500.000000",
  "requiredUnits": "1500000000",
  "available": "1200.500000",
  "availableUnits": "1200500000",
  "eoa": "0x1234abcd5678ef901234abcd5678ef901234abcd",
  "chainId": 137,
  "token": "USDC",
  "decimals": 6
}

Configuration

Recipients

Quotes

Payouts

Webhooks

Quote Preflight (Balance Check)

Query parameters

Response

​Query parameters

​Response

Query parameters

Response