Participants

List participant lots

List lots for a participant by asset. Only applicable to LOT inventory mode assets. Lots are filtered by expires_after and expires_before, so this list does not accept created_after or created_before.

get/v1/participants/{participant_id}/balances/lots

Request

Base URL: https://api.scrip.dev
URL: https://api.scrip.dev/v1/participants/{participant_id}/balances/lots
Auth: HTTP bearer

Path parameters

participant_idstring required

The participant's id, or ext: followed by the participant's external_id.

Query parameters

program_idstring uuid

Program ID

asset_idstring uuid required

Asset ID

status'AVAILABLE' | 'HELD' | 'DEFERRED' | 'CONSUMED' | 'EXPIRED'

Return only lots with this status

expires_beforestring

Filter lots expiring before this time (RFC 3339)

expires_afterstring

Filter lots expiring after this time (RFC 3339)

reference_idstring

Filter lots by reference_id correlation key

limitinteger

Return at most this many records, from 1 to 200, default 50.

cursorstring

The next_cursor from the previous response, valid only with the same endpoint and filters.

Response

List of lots with asset-wide availability reconciliation

Example response

{
  "availability": {
    "gross_available_lot_total": "20.00",
    "ledger_available_balance": "5.00",
    "overdraft_offset": "15.00",
    "spendable_available": "5.00"
  },
  "data": [
    {
      "amount": "100.00",
      "asset_id": "a3bb189e-8bf9-4c8b-9be0-6b5d2f4e7a02",
      "created_at": "2027-01-15T10:30:00Z",
      "expires_at": "2027-12-31T23:59:59Z",
      "id": "4a6c8e02-b1d3-4f57-9c80-e2a4b6d8f012",
      "matures_at": "2027-12-31T23:59:59Z",
      "reference_id": "auth_12345",
      "remaining": "75.50",
      "status": "AVAILABLE"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "YWJjMTIz"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.