← Technical API reference

Backend resource · STATIC DECLARATIONS

Payment API reference · mansoq-nhcx

Static source contract for Payment: 1 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-nhcx at /api/{installed_plugin_prefix}/payment/. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
POST /api/{installed_plugin_prefix}/payment/{external_id}/acknowledge/ acknowledge @action declaration

acknowledge · POST

POST /api/{installed_plugin_prefix}/payment/{external_id}/acknowledge/ — action acknowledge. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true
path external_id router lookup string; semantic ID validation requires handler/schema review true

decorator responses: PaymentNoticeRetrieveSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
identifier str true No extra constraint extracted
status str true No extra constraint extracted
period dict | None true No extra constraint extracted
outcome str | None true No extra constraint extracted
disposition str | None true No extra constraint extracted
payment_date datetime true No extra constraint extracted
payment_amount float true No extra constraint extracted
payment_identifier str | None true No extra constraint extracted
detail list | None true No extra constraint extracted
process_note list | None true No extra constraint extracted
request UUID4 true No extra constraint extracted
claim UUID4 true No extra constraint extracted
payment_reconciliation dict | None false No extra constraint extracted
created_date datetime | None false No extra constraint extracted
modified_date datetime | None false No extra constraint extracted

Authorization: no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

Declared refusal/error evidence: ValidationError (dynamic detail; inspect source).

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.