POST /v1/settlement-candidates/{candidate_id}/allocation-handoffs

Create Settlement Candidate Allocation Handoff

Record a human-reviewed CAMT.054 candidate-to-allocation handoff intent. No allocation or journal posting is performed.

Requires API key Idempotent OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader

Authorization: Bearer hc_...

Parameters

Idempotency-Keystringrequiredheader

Documented field.

candidate_idstringrequiredpath

Documented field.

Request body

Send JSON using the documented schema. Unknown or unsafe fields fail with structured validation errors where the endpoint owns validation.

end_customer_idstringoptionalbody

Documented field.

reviewer_justificationstringrequiredbody

Documented field.

target_document_idstringoptionalbody

Documented field.

target_override_reasonstringoptionalbody

Documented field.

payment_idstringoptionalbody

Documented field.

proposed_amountobjectoptionalbody

Documented field.

open_ar_snapshotobjectrequiredbody

Documented field.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

201Successful response.

defaultStructured error response.

401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.

api_key_expiredDocumented HelvCore error code for this operation.

idempotency_key_conflictDocumented HelvCore error code for this operation.

invalid_authDocumented HelvCore error code for this operation.

invalid_requestDocumented HelvCore error code for this operation.

missing_idempotency_keyDocumented HelvCore error code for this operation.

validation_failedDocumented HelvCore error code for this operation.

curl -X POST https://api.helvcore.ch/v1/settlement-candidates/{candidate_id}/allocation-handoffs \ -H "Authorization: Bearer $HELVCORE_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "open_ar_snapshot": { "amount_minor": 123, "currency": "CHF" }, "reviewer_justification": "string", "end_customer_id": "00000000-0000-4000-8000-000000000000", "payment_id": "string", "proposed_amount": { "amount_minor": 123, "currency": "CHF" }, "target_document_id": "string", "target_override_reason": "string" }'

{ "open_ar_snapshot": { "amount_minor": 123, "currency": "CHF" }, "reviewer_justification": "string", "end_customer_id": "00000000-0000-4000-8000-000000000000", "payment_id": "string", "proposed_amount": { "amount_minor": 123, "currency": "CHF" }, "target_document_id": "string", "target_override_reason": "string" }