Koin · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Koin Payments API

15 actions 15 updates security extends openapi/koin-payments-openapi.json
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
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