openapi: 3.2.0
info:
  title: Ppro Payment Charge Controller API
  version: v1
  description: 'Operations tagged payment-charge-controller across 2 of this provider''s published API definitions: ppro-fund-statuses-openapi.yml, ppro-gpg-funds.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sandbox.eu.ppro.com
  description: Production - Sandbox environment for integration testing
- url: https://api.eu.ppro.com
  description: Production
tags:
- name: payment-charge-controller
paths:
  /v1/payment-charges/{paymentChargeId}/funds-statuses:
    get:
      tags:
      - payment-charge-controller
      summary: Fetch latest available funds statuses for payment charge captures and refunds
      operationId: getFundsStatuses
      parameters:
      - name: paymentChargeId
        in: path
        required: true
        schema:
          type: string
      - name: Merchant-Id
        in: header
        description: The merchant identifier.
        required: true
        schema:
          type: string
        example: merch_cb6RQnZbBwSBkn34QYXhr
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FundsStateDetailsResponse'
    servers:
    - url: https://api.sandbox.eu.ppro.com
      description: Production - Sandbox environment for integration testing
    - url: https://api.eu.ppro.com
      description: Production
components:
  schemas:
    FundsStateDetailsResponse:
      type: object
      properties:
        operationId:
          type: string
          description: Capture ID or refund ID)
        operationType:
          type: string
          description: 'Operation type: CAPTURE or REFUND'
          enum:
          - CAPTURE
          - REFUND
        fundsStatus:
          type: string
          description: Funds status
          enum:
          - CAPTURE_FUNDS_NOT_EXPECTED
          - CAPTURE_FUNDS_MISSING
          - CAPTURE_FUNDS_WAITING
          - CAPTURE_FUNDS_RECEIVED
          - REFUND_FUNDS_NOT_EXPECTED
          - REFUND_FUNDS_REJECTED
          - REFUND_FUNDS_WAITING
          - REFUND_FUNDS_SENT
        merchantPaymentChargeReference:
          type: string
          description: Merchant's payment-charge reference. This field is available only when the operation type is `CAPTURE`
        merchantRefundReference:
          type: string
          description: Merchant's refund reference. This field is available only when the operation type is `REFUND`
x-refined-from:
- ppro-fund-statuses-openapi.yml
- ppro-gpg-funds.json