Earnipay Business API
Business profile management and FIRS configuration
Earnipay Business API is one of 13 APIs that Earnipay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Business. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 16 operations across 13 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against the base URL https://e-invoicing.earnipay.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Earnipay Business API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (JWT-auth).
An API key is passed in the header as X-API-Key (API-Key).
JWT-auth— Enter JWT tokenAPI-Key— API Key for third-party integrations
Paths & Operations 16
Across 13 paths, the API surfaces 16 operations — 1 DELETE, 3 GET, 7 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
Business profile management and FIRS configuration
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are CreateBusinessDto (11 properties), UpdateBusinessDto (9 properties), TestInterswitchConnectionDto (2 properties), UpdateFirsConfigDto (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Earnipay 12
Other APIs Earnipay publishes across the network.