Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Earnipay Payment Details API

The Payment Details API from Earnipay — 2 operation(s) for payment details.

Earnipay Payment Details API is one of 13 APIs that Earnipay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payment Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 2 paths, and defines 2 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.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://e-invoicing.earnipay.com/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Earnipay Payment Details 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 token
  • API-Key — API Key for third-party integrations

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payment Details 5
POST
/v1/payment-details
Create payment detail
PaymentDetailController_create_v1 1 param body → 201
GET
/v1/payment-details
List payment details
PaymentDetailController_findAll_v1 3 params → 200
GET
/v1/payment-details/{id}
Get payment detail
PaymentDetailController_findOne_v1 1 param → 200404
PATCH
/v1/payment-details/{id}
Update payment detail
PaymentDetailController_update_v1 2 params body → 200404
DELETE
/v1/payment-details/{id}
Delete payment detail
PaymentDetailController_remove_v1 2 params → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are UpdatePaymentDetailDto (4 properties), CreatePaymentDetailDto (4 properties). Each schema is shown below with its type and property counts.

CreatePaymentDetailDto
object
4 properties 3 required
UpdatePaymentDetailDto
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

earnipay-payment-details-api-openapi.yml Raw ↑

Other APIs Earnipay publishes across the network.

Earnipay App API
Earnipay APP Provider API
Earnipay Authentication API
Earnipay Bank API
Earnipay Business API
Earnipay Customers API
Earnipay Invoices API
Earnipay IRN Generator API
Earnipay Products API
Earnipay QR Code Generator API
Earnipay Team API
Earnipay Users API