find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/ordogrid:ordogrid-payments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: 'Company-scoped REST API for invoicing, Peppol and loyalty.


    **Getting started.** Create a key in Company → API keys, grant only the needed

    scopes, and call `GET /api/v1/me`. Send `Authorization: Bearer ik_live_...` or

    `X-Api-Key: ik_live_...`. The key identifies the company; no company header is

    needed. Session cookies do not authenticate business endpoints. This OpenAPI

    document is public metadata and contains no company or API-key values.


    **Scopes.** Every operation lists all required scopes. `resource:write` implies

    the registered `resource:read` scope. `peppol:send` and `fidelity:points:write`

    are standalone. Invoice prepayments additionally require `payments:write`.


    **Retry safety.** Operations that accept `Idempotency-Key` replay successful

    responses for 24 hours with `Idempotent-Replay: true`. Reusing a key for different

    contents returns 409 `IDEMPOTENCY_KEY_REUSED`; in-flight retries return 409

    `IDEMPOTENT_REQUEST_IN_PROGRESS`. Header support is shown only where implemented.

    Document and financial movement `external_id` values provide durable recovery

    within the key''s integration namespace, including after key rotation. Loyalty

    movements also accept a body `idempotency_key` stored on the ledger.


    **Money and settlement.** Document totals are JSON numbers. Financial amounts

    and settlement summaries are exact decimal strings; send decimal strings for

    payments. Check `/me` capabilities for currency precision and supported payment

    methods. Payment/refund operations record already-confirmed money movements.


    **Lists.** Paginated operations accept `limit` (1–100, default 25) and `offset`.

    Loyalty members and ledger round to 25/50/100-row pages. Scope, reward and card

    lists and financial history do not paginate.


    **Rate limits.** Authenticated calls are limited per key, per minute. Calls that

    reach the limiter carry `X-RateLimit-Limit`, `X-RateLimit-Remaining` and

    `X-RateLimit-Reset` (seconds until reset); 429 also carries `Retry-After`.


    **Errors.** JSON `{"code": "...", "message": "...", "details": {...}}`.

    `details` is optional. Branch on stable `code`, since messages may change.

    Unknown request fields are rejected on clients, documents, Peppol sends, members,

    points, rewards and cards. Program settings are normalized separately.


    **Peppol.** Structured fields build UBL XML. `POST /api/v1/peppol/send` creates

    an invoice and transmits it; supplying `pdf` uses your exact rendering as its

    attachment. Existing invoices and credit notes have dedicated send routes.

    Approval and monthly quota apply. Archive the exchanged XML and original PDF;

    `view=current` renders the current settlement and can differ from issued bytes.

    For an uncertain transmission, read its status and reconcile the outcome before

    attempting another send.'
  title: OrdoGrid Public Payments API
  version: 1.4.0
servers:
- url: /
security:
- ApiKeyAuth: []
- ApiKeyHeader: []
tags:


# --- truncated at 32 KB (48 KB total) ---
# Full source: https://artifacts.apis.io/ordogrid/openapi/ordogrid-payments-api-openapi.yml