CHF and REST API Codes

MATRIXX CHF network functions communicate using REST APIs. Each REST API consists of an HTTP method, a configurable URI, and a pair of mapping files.

REST API shows the REST APIs, the URIs used by the CHF, and the mapping files that are used by default. The URI, mapping and OpenAPI specification are all configurable, and only the HTTP method and mapping filename are not configurable.

Note: In REST API, hyphens have been added to some mapping file names to improve legibility.
Table 1. REST API
HTTP Method Configurable URI Mapping File(s) Specification
POST /nchf-convergedcharging/v2/chargingdata ChargingDataRequest

ChargingDataResponse

 TS32291_Nchf_ConvergedCharging.yaml
POST /nchf-convergedcharging/v2/chargingdata/{ChargingDataRef}/update ChargingDataRequest

ChargingDataResponse

 TS32291_Nchf_ConvergedCharging.yaml
POST /nchf-convergedcharging/v2/chargingdata/{ChargingDataRef}/release ChargingDataRequest

ChargingDataResponse

 TS32291_Nchf_ConvergedCharging.yaml
POST /nchf-spendinglimitcontrol/v1/subscriptions SpendingLimitRequest-SpendingLimitResponse TS29594_Nchf_SpendingLimitControl.yaml
PUT /nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId} SpendingLimitRequest-SpendingLimitResponse TS29594_Nchf_SpendingLimitControl.yaml
DELETE /nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId} SpendingLimitRequest-SpendingLimitResponse TS29594_Nchf_SpendingLimitControl.yaml

For more information about how mapping files and specification files are configured, see the discussion about mapping JSON messages to MDC in MATRIXX 5G Integration.

Outgoing Requests (CHF-originated) shows the outgoing requests originating from the CHF:

Table 2. Outgoing Requests (CHF-originated)
MDC Name Mapper Name
Mtx5GChargingNotifyRequest ChargingNotifyRequest

ChargingNotifyResponse
Mtx5GSpendingLimitNotifyRequest SpendingLimitNotifyStatusRequest

SpendingLimitNotifyStatusResponse
Mtx5GSubscriptionTerminationRequest SpendingLimitNotifyTerminateRequest

SpendingLimitNotifyTerminateResponse