Deluxe · OpenAPI Overlay 1.0.0

API Evangelist enhancements — DPP Gateway Experience API

4 actions 4 updates update extends openapi/deluxe-dpp-gateway-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Deluxe's API. It is a proposal applied on top of the contract, not a document Deluxe publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-providerx-provider-idx-developer-portalx-credential-requestx-self-serve-signupx-idempotencyx-rate-limitsx-error-semantics

Targets 2

$.info

$.paths['/events/subscribe'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements — DPP Gateway Experience API
  version: 1.0.0
extends: openapi/deluxe-dpp-gateway-openapi.yml
x-provenance:
  generated: '2026-08-13'
  method: generated
  source: API Evangelist enrichment pass; findings recorded in conventions/, errors/, lifecycle/, rate-limits/,
    sandbox/ and asyncapi/ in this repo.
  note: Annotations only. This overlay adds no operation, field or schema; it records what the Deluxe contract does
    NOT say, so an agent reading the spec is not left to assume.
actions:
- target: $.info
  update:
    x-provider: Deluxe Corporation
    x-provider-id: deluxe
    x-developer-portal: https://developer.deluxe.com/
    x-credential-request: isvinquiries@deluxe.com
    x-self-serve-signup: false
- target: $.info
  update:
    x-idempotency:
      supported: false
      header: null
      note: Deluxe documents no idempotency key on any operation. Retrying a POST may duplicate a money movement.
    x-rate-limits:
      documented: false
      response_headers: []
      exhaustion_status: null
      note: No published limits and no rate-limit response headers anywhere in the Deluxe contract.
    x-error-semantics:
      rfc9457: false
      business_failures_use_http_200: true
      code_field: responseCode
      message_field: responseMessage
      success_value: 0
      catalog: errors/deluxe-decline-codes.yml
      note: 57 published gateway/issuer codes; 30 of them share the identical masked message "REQUEST DECLINED!".
    x-deprecation-policy:
      published: false
      sunset_header: false
    x-status-page:
      published: false
    x-sandbox:
      available: true
      self_serve: false
      host: https://sandbox.api.deluxe.com
      artifact: sandbox/deluxe-sandbox.yml
- target: $.info
  update:
    x-source-contract:
      format: RAML 1.0
      url: https://developer.deluxe.com/api-ref/api/merchant-services/
      archived_in_repo: raml/
      note: Deluxe publishes this API as RAML 1.0, not OpenAPI. The OpenAPI this overlay extends is a faithful mechanical
        conversion of that RAML plus the rendered parameter and example documents from the same portal.
- target: $.paths['/events/subscribe'].post
  update:
    x-webhook-catalog:
      artifact: asyncapi/deluxe-webhooks.yml
      event_types:
      - MERCHANT BOARDED
      - MERCHANT UPDATED
      - CC BATCH
      - ACH BATCH
      - ACH REJECT
      - TRANSACTION
      - VAULT
      - CC CHARGEBACK
      payload_schemas_published: false
      asyncapi_published: false
      signature_verification_documented: false