Read the balance owed on a booking obligation

GET

/obligations/{obligation_ref}/balance

curl --request GET \
  --url https://quikstik-core.fly.dev/obligations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/balance

• Production

The remaining balance (gross - settled) on a booking obligation, backing the “Complete payment - $X” surface. Capability-gated by the unguessable obligation_ref. Fail-closed: 503 when no obligation backend is wired; 404 when no obligation row exists.

Parameters

Path Parameters

obligation_ref

required

string format: uuid

Responses

200

The balance owed

Media typeapplication/json

object

amount_minor

required

Balance owed in minor units (cents).

integer format: int64

currency

required

ISO currency code (e.g. USD).

string

Example ^generated

{
  "amount_minor": 1,
  "currency": "example"
}

404

No obligation row for this reference

Media typeapplication/json

object

reason

required

Stable, machine-readable reason code (e.g. “sold_out”, “processor_not_configured”, “rail_refused”).

string

Example

{
  "reason": "sold_out"
}

503

No durable backend is wired for this operation (fail-closed)

Media typeapplication/json

object

reason

required

Stable, machine-readable reason code (e.g. “sold_out”, “processor_not_configured”, “rail_refused”).

string

Example

{
  "reason": "sold_out"
}