API Reference — Payment Gateway Reconciliation

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Payment Gateway Reconciliation
  description: 'API Reference — Payment Gateway Reconciliation. 4 operations. Lead operation: Reverse a payment. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Payment Gateway Reconciliation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-payment-gateway-reconciliation
    baseUri: https://rest.zuora.com
    description: API Reference — Payment Gateway Reconciliation business capability. Self-contained, no shared references.
    resources:
    - name: v1-gateway-settlement-payments-payment-key-chargeback
      path: /v1/gateway-settlement/payments/{payment-key}/chargeback
      operations:
      - name: postreversepayment
        method: POST
        description: Reverse a payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payment-key
          in: path
          type: string
          description: The payment number starting with "P-" or the unique payment ID.
          required: true
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-gateway-settlement-payments-payment-key-reject
      path: /v1/gateway-settlement/payments/{payment-key}/reject
      operations:
      - name: postrejectpayment
        method: POST
        description: Reject a payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payment-key
          in: path
          type: string
          description: The payment number starting with "P-" or the unique payment ID.
          required: true
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-gateway-settlement-payments-payment-key-settle
      path: /v1/gateway-settlement/payments/{payment-key}/settle
      operations:
      - name: postsettlepayment
        method: POST
        description: Settle a payment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payment-key
          in: path
          type: string
          description: The payment number starting with "P-" or the unique payment ID.
          required: true
        - name: Request
          in: body
          type: string
          required: true
    - name: v1-refunds-refund-key-reconcile
      path: /v1/refunds/{refund-key}/reconcile
      operations:
      - name: postreconcilerefund
        method: POST
        description: Reconcile a refund
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: refund-key
          in: path
          type: string
          description: The refund number starting with “R-” or the unique refund ID.
          required: true
        - name: Request
          in: body
          type: string
          required: true
  exposes:
  - type: rest
    namespace: v1-payment-gateway-reconciliation-rest
    port: 8080
    description: REST adapter for API Reference — Payment Gateway Reconciliation. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/gateway-settlement/payments/{payment-key}/chargeback
      name: v1-gateway-settlement-payments-payment-key-chargeback
      description: REST surface for v1-gateway-settlement-payments-payment-key-chargeback.
      operations:
      - method: POST
        name: postreversepayment
        description: Reverse a payment
        call: v1-payment-gateway-reconciliation.postreversepayment
        with:
          payment-key: rest.payment-key
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/gateway-settlement/payments/{payment-key}/reject
      name: v1-gateway-settlement-payments-payment-key-reject
      description: REST surface for v1-gateway-settlement-payments-payment-key-reject.
      operations:
      - method: POST
        name: postrejectpayment
        description: Reject a payment
        call: v1-payment-gateway-reconciliation.postrejectpayment
        with:
          payment-key: rest.payment-key
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/gateway-settlement/payments/{payment-key}/settle
      name: v1-gateway-settlement-payments-payment-key-settle
      description: REST surface for v1-gateway-settlement-payments-payment-key-settle.
      operations:
      - method: POST
        name: postsettlepayment
        description: Settle a payment
        call: v1-payment-gateway-reconciliation.postsettlepayment
        with:
          payment-key: rest.payment-key
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/refunds/{refund-key}/reconcile
      name: v1-refunds-refund-key-reconcile
      description: REST surface for v1-refunds-refund-key-reconcile.
      operations:
      - method: POST
        name: postreconcilerefund
        description: Reconcile a refund
        call: v1-payment-gateway-reconciliation.postreconcilerefund
        with:
          refund-key: rest.refund-key
          Request: rest.Request
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-payment-gateway-reconciliation-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Payment Gateway Reconciliation. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: reverse-payment
      description: Reverse a payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-payment-gateway-reconciliation.postreversepayment
      with:
        payment-key: tools.payment-key
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: reject-payment
      description: Reject a payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-payment-gateway-reconciliation.postrejectpayment
      with:
        payment-key: tools.payment-key
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: settle-payment
      description: Settle a payment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-payment-gateway-reconciliation.postsettlepayment
      with:
        payment-key: tools.payment-key
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.
    - name: reconcile-refund
      description: Reconcile a refund
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-payment-gateway-reconciliation.postreconcilerefund
      with:
        refund-key: tools.refund-key
        Request: tools.Request
      outputParameters:
      - type: object
        mapping: $.