POST /v1/manual-payments/{payment_id}/reverse

Reverse Manual Payment

Reverse a manual receipt by additive evidence record.

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.

payment_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_idstringrequiredbody

Documented field.

reasonstringrequiredbody

Documented field.

correctionobjectoptionalbody

Documented field.

Returns

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

202Successful 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/manual-payments/{payment_id}/reverse \ -H "Authorization: Bearer $HELVCORE_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "end_customer_id": "00000000-0000-4000-8000-000000000000", "reason": "string", "correction": { "amount": { "amount_minor": 123, "currency": "CHF" }, "event_date": "2026-03-31", "source_channel": "manual", "reference": "string", "source_evidence_sha256": "string" } }'

{ "end_customer_id": "00000000-0000-4000-8000-000000000000", "reason": "string", "correction": { "amount": { "amount_minor": 123, "currency": "CHF" }, "event_date": "2026-03-31", "source_channel": "manual", "reference": "string", "source_evidence_sha256": "string" } }