Balances

Retrieve a balance

Scope: read

get/v1/balances/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/balances/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:bal_part_7uSyy9FqVLCFWrdPeZaK_USD

Query parameters

string
OR
string[]
string
OR
string[]

Response

The balance

idstring required

bal_<partner_id>_<currency>

object'balance' required
partner_idstring required

Prefixed id (part_…)

currencystring required

ISO-4217

pending_minorinteger required

Integer minor units (cents, pence). Never a float, never a string.

due_minorinteger required

Integer minor units (cents, pence). Never a float, never a string.

paid_minorinteger required

Integer minor units (cents, pence). Never a float, never a string.

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "bal_part_7uSyy9FqVLCFWrdPeZaK_USD",
  "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
  "currency": "USD",
  "pending_minor": 2500,
  "due_minor": 2500,
  "paid_minor": 2500,
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

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