Replace a transaction's saved category allocation overlay.

Replace a transaction's saved category allocation overlay.

post/v1/transactions/split

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/transactions/split
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

transaction_idstring required

The canonical transaction this concerns.

approval_notestring

What the user said about this split, in their words, when they said something. Optional; without it the action's reason is kept. How a charge should be divided reflects what it was for, which they know and you infer.

approval_sourcestring

Where the user said it, such as the conversation or message it came from.

set_bystring

Who made the change, when it was not you acting alone.

Response

Envelope with the active split and allocation lines.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

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