Binding

This section describes a concrete communication binding (e.g., HTTPS, file transfer, WebSocket). All content in this section is non-normative and provided as an example implementation.

Concrete Specification

Prerequisites

• This protocol uses HTTPS (TLS 1.2 or higher) and communicates via RESTful HTTP request/response.

• Endpoints: HTTP methods (GET, POST, PUT, DELETE) are used against specified URIs.

• Data Format: Request and response bodies use JSON format.

• Authentication and Authorization: OAuth 2.0-based token authentication is used.

• Security Requirements: TLS 1.2 or higher is required to ensure encrypted communication.

Field Definitions

For each field used in this binding, the following information is provided:

• Field Name: Name used within this binding

• Type: Data type (e.g., integer, string)

• Requirement: Usage condition of the field

  • R = Required

  • C = Conditional

  • O = Optional

• Request: Used in request messages

• Response: Used in response messages

• Description: Meaning and usage of the field

Header Field Definitions

Field Name	Type	Required	Request	Response	Description
x-payment-api-key	String	R	✔		Specifies the API key issued per client application. ODS-specific field.
Authorization	String	R	✔		Specifies the access token. Example: Bearer .
Content-Type	String	R	✔	✔	Specifies the request format.
User-Agent	String	R	✔		Specifies the client user agent.
Accept-Language	String	O	✔		Specifies the client’s preferred language.
X-TrackingID	String	R	✔	✔	Specifies a unique ID used for request tracing. ODS-specific field.
Content-Security-Policy	String	R		✔	Specifies content loading and execution policies and controls allowed script and resource origins.
X-Content-Type-Options	String	R		✔	Prevents MIME-type sniffing by browsers and enforces the declared Content-Type.
Strict-Transport-Security	String	R		✔	Enforces HTTPS connections for a specified period and prevents downgrade to HTTP.
Cache-Control	String	R		✔	Specifies cache control mechanisms.
ETag	String	C		✔	Specifies a resource version identifier. Mandatory in responses to GET requests.
Last-Modified	String	C		✔	Specifies the last modified date and time of the resource. Mandatory in responses to GET requests.

Payload Field Definitions

Since the Request and Response fields differ for each function of this protocol, refer to the API Specification.

Functional Description

For detailed implementations such as Sent by, Resulting state(s), Request, Response, Examples, Error lists, and API-specific field definitions, refer to the API Specification.

Category	Function	Description	API Specification
Usage Fee Model	Register / Retrieve / Update / Delete Usage Fee Model	Performs operations related to usage fee models that define pricing information for service usage. Usage fee models are defined per Data Provider, Data Consumer, and exchange target data.	(Reference URL)
Transaction Information	Transaction Eligibility Check	Verifies whether a transaction is permitted for service usage. A transaction ID is issued when checking eligibility, and subsequent transaction information is managed using this ID.	(Reference URL)
Transaction Information	Register / Update Data Exchange Status	Registers transaction status (success/failure) from Data Consumers and Data Providers.	(Reference URL)
Transaction Information	Retrieve Payment Status	Allows a Data Provider to check the payment status associated with transaction information.	(Reference URL)
Billing / Payment	Retrieve Planned Billing Amount	Retrieves the planned billing amount for a Data Provider.	(Reference URL)
Billing / Payment	Retrieve Planned Payment Amount	Retrieves the planned payment amount for a Data Consumer.	(Reference URL)

Sequence Diagrams

Usage Fee Model Registration / Update / Retrieval / Deletion

Purchase Processing

Purchase Confirmation Processing

• The purchase confirmation process is executed in accordance with the timing of log output from the Logging component.

Payment Processing

• A transaction is treated as eligible for planned billing and planned payment amounts when the data exchange status from the Data Consumer is “completed,” the data exchange status from the Data Provider is “completed,” and the data exchange log status is “successful.”

Payment Status Retrieval

• The Data Provider retrieves transaction information with a specified Data Consumer, filtered by time period and clearing/payment status.