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

Innago Payments API

Manage payments

Innago Payments API is one of 9 APIs that Innago publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, rate-limit docs, and 4 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api-my.innago.com/openapi.

3 operations 3 paths 9 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api-my.innago.com/openapi/v1
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Innago Payments API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 3

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

Payments 3

Manage payments

POST
/v1/invoices/{invoiceUid}/payments
Record payment towards an invoice
recordPaymentByInvoice 1 param body → 200
GET
/v1/payments
Get all payments
listPayments 6 params → 200
GET
/v1/payments/{paymentUid}
Get payment by ID
getPayment 1 param → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are PaymentWithAdditionalInfoResponse (12 properties), PaymentInfoModel (8 properties), PaymentTransactionModel (7 properties), PagingModel (4 properties). Each schema is shown below with its type and property counts.

PaymentInfoModel
object
8 properties
PaymentTransactionModel
object
7 properties
PaymentInfoResponseModelResponse
object
2 properties
RecordPaymentResponseModelResponse
object
2 properties
ErrorResponse
object
2 properties
PaymentWithAdditionalInfoResponse
object
12 properties
PaymentWithAdditionalInfoListResponseResponse
object
2 properties
RecordPaymentRequestModel
object
2 properties 2 required
PagingModel
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

innago-payments-api-openapi.yml Raw ↑

Other APIs Innago publishes across the network.

Innago Expenses API
Innago External References API
Innago Health API
Innago Invoices API
Innago Leases API
Innago Maintenance API
Innago Properties API
Innago Tenants API