HIFI Docs

GET

orchestration-addresses

deposits

{orchestrationDepositId}

Retrieve an orchestration deposit

curl --request GET \
  --url https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "orchestrationAddressId": "<string>",
  "batchId": "<string>",
  "amount": "<string>",
  "currency": "usdc",
  "chain": "<string>",
  "sourceAddress": "<string>",
  "transactionHash": "<string>",
  "status": "PENDING",
  "ignoredReason": "ADDRESS_DEACTIVATED",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orchestrationDepositId

string

required

Globally unique public ID of the orchestration deposit.

Pattern: ^orchdep_.+$

Response

A single deposit record.

A single on-chain deposit detected for an orchestration address.

string

required

Public orchestration-deposit ID prefixed with orchdep_.

orchestrationAddressId

string

Public orchestration-address ID prefixed with orchaddr_.

batchId

string | null

Public orchbat_ ID of the batch that included this deposit. null while status=PENDING or status=IGNORED.

amount

string

Decimal amount of the source token deposited (e.g. "100.500000"). Precision matches the token's on-chain decimals.

currency

enum<string>

Available options:

usdc,

usdt

chain

string

Abbreviated chain name (e.g. BASE).

sourceAddress

string

On-chain address that sent the deposit. Informational only.

transactionHash

string

On-chain transaction hash.

status

enum<string>

Per-deposit status.

PENDING — recorded, waiting to be rolled into a batch.
BATCHED — included in a batch (batchId is set).
IGNORED — recorded but never batched. See ignoredReason for why.
REFUNDED — was PENDING when the address was deactivated; the funds were refunded in-kind to the walletAddress supplied at deactivation.

Available options:

PENDING,

BATCHED,

IGNORED,

REFUNDED

ignoredReason

enum<string> | null

Why a deposit was ignored. Funds remain in the escrow wallet — a Slack alert fires for manual ops follow-up.

ADDRESS_DEACTIVATED — the deposit arrived after the address was deactivated.
UNSUPPORTED_TOKEN — the deposited token does not match the address's configured source.currency (e.g. USDT sent to a USDC-only address).

Available options:

ADDRESS_DEACTIVATED,

UNSUPPORTED_TOKEN

createdAt

string<date-time>

updatedAt

string<date-time>

⌘I

Retrieve an orchestration deposit

curl --request GET \
  --url https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://production.hifi.com/v3/orchestration-addresses/deposits/{orchestrationDepositId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "orchestrationAddressId": "<string>",
  "batchId": "<string>",
  "amount": "<string>",
  "currency": "usdc",
  "chain": "<string>",
  "sourceAddress": "<string>",
  "transactionHash": "<string>",
  "status": "PENDING",
  "ignoredReason": "ADDRESS_DEACTIVATED",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Overview

Endpoints

Retrieve an orchestration deposit

Authorizations

Path Parameters

Response