API reference›Documents›Put Document Payment References
104 operations ↓ OpenAPI JSON Get API key
PUT /v1/documents/{document_id}/payment-references

Put Document Payment References

Register expected external QRR/SCOR payment references for deterministic bank-statement matching.

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.

document_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.

referencesarrayrequiredbody

Full replacement set of active expected payment references for the document.

reasonstringoptionalbody

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.