Skip to main content
GET
Get a collection

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Headers

HERMES-ORG
string<uuid>

The id of one of your Child orgs. The call then acts on that Child org, not on your organization. If you do not send it, the call acts on your organization. An id that is not one of your Child orgs gives 404.

Example:

"3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10"

Path Parameters

id
string
required

The collection id.

Response

The collection.

id
string<uuid>
required

The collection id.

asset
string
required

An asset code as GET /v2/assets lists it — uppercase, never compound (USDC, USD; never USDC-ETHEREUM). Network and rail live on the payment object.

Minimum string length: 1
Example:

"USDC"

amount
string
required

What landed: the amount credited to your balance in this asset, as an exact decimal string. This is the one money figure a collection carries — there is no separate fee line.

Example:

"993.00"

status
enum<string>
required

settled — credited to your balance. reversed — the payer’s bank or the network clawed the money back after it was credited; your balance is corrected by Jenzy.

Available options:
settled,
reversed
source
object
required

Where the money came in — the mirror of a payout’s destination.

created_at
string<date-time>
required