Skip to main content
Download OpenAPI

OpenAPI Specification Changelog

info

This page documents upcoming changes to the E-Receipts OpenAPI specification. Use the Download OpenAPI button above to get the updated specification file.

Versioning​

All endpoints are now prefixed by /v1, to account for future API versioning and to make future changes easier to manage without breaking existing integrations.

mTLS Port Configuration​

You no longer need to specify port 444 for endpoints using mTLS. All communications must use port 443; requests sent to port 444 will fail.

Endpoint - Telemetry​

The endpoint used to retrieve PEM telemetry data has been updated to remove the path parameter.

  • Previous Path: GET /mf1/pems/{serial_number}/telemetry
  • New Path: GET /v1/mf1/pems/telemetry

The serial number is now retrieved directly from the client certificate.

Endpoint - Create Sale Receipt​

Payment Details​

The body of the POST /v1/mf1/receipts endpoint has been modified to better organize payment information.

The following fields have been removed:

  • discount
  • services_uncollected_amount
  • goods_uncollected_amount
  • cash_payment_amount
  • electronic_payment_amount
  • ticket_restaurant_payment_amount
  • ticket_restaurant_quantity

They have been replaced by a new payment_details array. Each element is a PaymentDetail object with these fields:

  • amount
  • description
  • type (accepted values include cash, electronic, ticket, discount, credit, rounding_up, among others).
  • an optional ticket_quantity

DCN field renaming​

The boolean field uncollected_dcn_to_ssn has been renamed to uncollected_dcr_to_ssn

Endpoint - Create Cash Register​

The response of the POST /v1/mf1/cash-registers endpoint has been restructured to group the mTLS credentials and add a PKCS#12 bundle.

Previously, the certificate and private key were returned as separate top-level fields:

  • mtls_certificate — PEM-encoded certificate
  • private_key — PEM-encoded private key

They are now nested under mtls_certificate, which provides both PEM and PKCS#12 formats:

"mtls_certificate": {
  "pem": {
    "certificate": "string",
    "private_key": "string"
  },
  "pkcs12": "string"
}

The pem object contains the same certificate and key as before. If you previously stored them as separate files, read mtls_certificate.pem.certificate and mtls_certificate.pem.private_key instead.

The pkcs12 field contains the certificate and private key bundled as a single PKCS#12 (.p12) archive.

Last updated on