HIhifi
Orchestration Address

List batches for an orchestration address

List batches produced from this address's deposits. Each batch carries the IDs of the deposits it rolled up and (once the worker runs) the offrampTransactionId of the produced offramp.

To get full offramp details, call GET /v2/offramps/{offrampTransactionId}.

get/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/batches

Request

  • Base URL
    https://production.hifibridge.com
  • URL
    https://production.hifibridge.com/v2/users/{userId}/orchestration-addresses/{orchestrationAddressId}/batches
  • Auth
    HTTP bearer

Path parameters

userIdstring required

ID of the user

orchestrationAddressIdstring uuid required

ID of the orchestration address.

Query parameters

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED'

Filter batches by status.

createdAfterstring date-time

Inclusive lower bound on createdAt (ISO 8601). Only records created at or after this timestamp are returned.

createdBeforestring date-time

Cursor for the next page. Pass the previous response's nextCursor value to return records created strictly before that timestamp.

limitinteger

Maximum number of records to return. 1–200, defaults to 50.

Response

A paginated list of batches for the named orchestration address.

countinteger
nextCursorstring date-time nullable

Pass this value as createdBefore to retrieve the next page. null means no next page is advertised.

Example response

{
  "records": [
    {
      "totalAmount": "150.000000"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.