Operator off-session settlement of a deposit's remaining balance on the vaulted card

POST

/obligations/{obligation_ref}/charge-balance

const url = 'https://quikstik-core.fly.dev/obligations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/charge-balance';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://quikstik-core.fly.dev/obligations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/charge-balance \
  --header 'Authorization: Bearer <token>'

Live operator mutation (previously implemented but undocumented — closed by gap-analysis X1). Reuses RecordCaptureCommand internally; all amounts are server-derived; no request body. Fail-closed on missing vaulted instrument or missing tax/effective-date.

Authorizations

bearerAuth

Parameters

Path Parameters

obligation_ref

required

string format: uuid

Responses

200

Balance captured; capture totals returned

402

Processor not connected

404

Unknown obligation

409

Nothing owed / already settled

422

No vaulted instrument or missing tax/effective-date

application/json

object

reason

required

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

string

Example

{
  "reason": "sold_out"
}

502

Processor failure

503

Rail unavailable