Koin · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Koin Payments API

15 actions 15 updates security extends openapi/koin-payments-openapi.json
Derived by API Evangelist Built from the contracts Koin publishes. Koin did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-idempotencyx-apievangelist-providerx-apievangelist-generatedx-apievangelist-artifactssecuritySchemessecurity

Targets 15

$.info
$.components
$
$.paths['/v1/payment/tokenize'].post
$.paths['/v1/payment/orders'].post
$.paths['/v1/payment/orders/{order_id}/capture'].post
$.paths['/v1/payment/orders/{order_id}/refund'].put
$.paths['/v1/payment/orders/{order_id}/notifications'].post
$.paths['/v1/payment/payment-key/info'].post
$.paths['/v1/payment/orders/{order_id}/cancel'].put
$.paths['/v1/payment/orders/availability'].post
$.paths['/v1/payment/payouts/currencies'].post
$.paths['/v1/payment/payouts/quotation'].post
$.paths['/v1/payment/payouts'].post
$.paths['/v1/payment/orders/{order_id}/account-validation'].post

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Koin Payments API
  version: 1.0.0
extends: openapi/koin-payments-openapi.json
actions:
- target: $.info
  update:
    x-apievangelist-provider: koin
    x-apievangelist-generated: '2026-07-19'
    x-apievangelist-artifacts:
      authentication: authentication/koin-authentication.yml
      conventions: conventions/koin-conventions.yml
      errors: errors/koin-problem-types.yml
      decline_codes: errors/koin-decline-codes.yml
      webhooks: asyncapi/koin-payments-webhooks.yml
      sandbox: sandbox/koin-sandbox.yml
      lifecycle: lifecycle/koin-lifecycle.yml
      data_model: data-model/koin-data-model.yml
- target: $.components
  update:
    securitySchemes:
      KoinPrivateKey:
        type: http
        scheme: bearer
        description: 'Koin private key, format sk_ + 32 alphanumeric characters, issued during merchant
          onboarding. Sent as Authorization: Bearer <private key>. See https://api-docs.koin.com.br/docs/security-scheme'
- target: $
  update:
    security:
    - KoinPrivateKey: []
- target: $.paths['/v1/payment/tokenize'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/orders'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/orders/{order_id}/capture'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/orders/{order_id}/refund'].put
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/orders/{order_id}/notifications'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/payment-key/info'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/orders/{order_id}/cancel'].put
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/orders/availability'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/payouts/currencies'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/payouts/quotation'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/payouts'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml
- target: $.paths['/v1/payment/orders/{order_id}/account-validation'].post
  update:
    x-idempotency:
      model: reference-id
      key_field: reference_id
      note: Koin requires a stable unique reference_id per business transaction (integration requirement
        COR1); replays must not produce duplicate side effects (INF4/CBK3). Duplicate submissions surface
        as HTTP 409 or business codes 511/998.
      artifact: conventions/koin-conventions.yml

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay 
curl "https://apis.io/api/v1/overlays/koin-payments-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.