Preview a manual transaction through the curated import pipeline.

Preview a manual transaction through the curated import pipeline.

post/v1/manual/transactions/preview

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/manual/transactions/preview
  • 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

source_account_idstring required

The account this belongs to.

amountstring required

Exact money, as a plain signed decimal in the account's currency.

datestring date required

When the activity posted, as an ISO calendar date.

descriptionstring required

The source description, kept as written so the record stays evidence.

merchant_namestring
categorystring

The effective category this line governs.

reference_numberstring
set_bystring

Response

Envelope with the staged import batch and approval command.

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.