Skip to main content
GET
/
v2
/
users
/
{userId}
/
orchestration-addresses
/
{orchestrationAddressId}
/
batches
/
{batchId}
Retrieve a batch
curl --request GET \
  --url https://production.hifibridge.com/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/batches/{batchId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orchestrationAddressId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "totalAmount": "150.000000",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "depositIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "offrampTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
userId
string
required

ID of the user

​
orchestrationAddressId
string<uuid>
required

ID of the orchestration address.

​
batchId
string<uuid>
required

ID of the orchestration batch.

Response

A single batch record (with its included deposit IDs and the linked offramp).

A batch of one or more deposits rolled up into a single offramp transaction.

​
id
string<uuid>
​
orchestrationAddressId
string<uuid>
​
totalAmount
string

Sum of the included deposits' amounts, in the source currency.

Example:

"150.000000"

​
currency
enum<string>
Available options:
usdc,
usdt
​
status
enum<string>

Batch lifecycle.

  • PENDING — created; the worker has not yet picked it up.
  • PROCESSING — the linked offramp has been created and is in flight.
  • COMPLETED — the linked offramp reached COMPLETED.
  • FAILED — terminal failure. See failureReason.
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
failureReason
enum<string> | null

Populated when status=FAILED.

  • ADDRESS_NOT_ACTIVE — the address was deactivated before the worker created the offramp. The only input condition that terminally fails a batch.
  • All other values are terminal statuses surfaced from the linked offramp transaction (e.g. lost product access → NOT_INITIATED, a rejected AML review → a terminal status).

Internal inconsistencies (missing address, payout account lost its rail, a processor-validation bug) do not appear here — the worker pauses the batch (leaves it PENDING) and alerts ops instead of marking it FAILED.

Available options:
ADDRESS_NOT_ACTIVE,
NOT_INITIATED,
QUOTE_FAILED,
CRYPTO_FAILED,
FIAT_FAILED,
EXPIRED,
REJECTED,
CANCELLED
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
depositIds
string<uuid>[]

IDs of all deposits included in this batch.

​
offrampTransactionId
string<uuid> | null

ID of the offramp transaction produced from this batch. null while status=PENDING (the worker has not yet created the offramp). Call GET /v2/offramps/{transferId} for full offramp details.