Chimoney Pass Through API

openapi: 3.2.0
info:
  title: Chimoney API Docs Pass Through API
  version: 0.2.4
  description: This is the latest version of the Chimoney API. For deprecated version routes, please refer to /v0.2/api-docs.
servers:
- url: https://api.chimoney.io/
  description: Prod Server
- url: https://api-v2-sandbox.chimoney.io
  description: Sandbox API v2 (v0.2.4)
security:
- apiKeyAuth: []
tags:
- name: Pass-through
paths:
  /v0.2.4/pass-through/payment-attempt:
    post:
      summary: Reserve the next Volume payment ID after an SDK authorization event
      description: Core generates and persists the replacement merchantPaymentId and reference. Replaying the same consumed ID returns its existing replacement while it remains current. This does not confirm settlement or create a new payout.
      tags:
      - Pass-through
      security:
      - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - issueID
              - merchantPaymentId
              additionalProperties: false
              properties:
                issueID:
                  type: string
                  maxLength: 160
                merchantPaymentId:
                  type: string
                  maxLength: 50
                  description: ID used by the attempt that emitted PAYMENT_AUTHORIZED_SDP
                paymentId:
                  type: string
                  format: uuid
                  description: Optional provider ID, only when supplied by the SDK
                subAccount:
                  type: string
      responses:
        '200':
          description: Replacement identifiers in data, including reference, expiresAt and reused
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Collection closed or attempt no longer eligible; refresh transfer status
        '500':
          $ref: '#/components/responses/ServerError'
      operationId: postV024PassThroughPaymentAttempt
      x-operation-id-source: derived
  /v0.2.4/pass-through/status:
    post:
      summary: Get one customer-visible pass-through remittance status
      tags:
      - Pass-through
      security:
      - apiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - issueID
              properties:
                issueID:
                  type: string
                subAccount:
                  type: string
      responses:
        '200':
          description: Parent status with collection, payout and refund legs
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: postV024PassThroughStatus
      x-operation-id-source: derived
  /v0.2.4/pass-through/history:
    post:
      summary: Get customer-visible pass-through remittance history
      tags:
      - Pass-through
      security:
      - apiKeyAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subAccount:
                  type: string
                limit:
                  type: integer
                  minimum: 1
                  maximum: 200
      responses:
        '200':
          description: One row per pass-through remittance
      operationId: postV024PassThroughHistory
      x-operation-id-source: derived
  /v0.2.4/pass-through/search:
    post:
      summary: Search pass-through remittances for reconciliation
      tags:
      - Pass-through
      security:
      - apiKeyAuth: []
      responses:
        '200':
          description: Matching remittances owned by the authenticated account
      operationId: postV024PassThroughSearch
      x-operation-id-source: derived
  /v0.2.4/pass-through/ledger-history:
    post:
      summary: Get an owned clearing ledger's transaction history
      tags:
      - Pass-through
      security:
      - apiKeyAuth: []
      responses:
        '200':
          description: Ledger history as JSON or CSV
      operationId: postV024PassThroughLedgerHistory
      x-operation-id-source: derived
components:
  schemas:
    ValidationError:
      type: object
      properties:
        status:
          type: string
          description: Status of the validation error.
          example: error
        type:
          type: string
          description: Type of validation error.
          example: Validation Error
        code:
          type: string
          description: Error code indicating validation issue.
          example: INVALID_REQUEST
        message:
          type: string
          description: Detailed validation error message.
          example: The request parameters are invalid.
    NotFound:
      type: object
      properties:
        status:
          type: string
          description: Status of the error.
          example: error
        type:
          type: string
          description: Type of error indicating resource not found.
          example: Resource Not Found
        code:
          type: string
          description: Error code for resource not found.
          example: NOT_FOUND
        message:
          type: string
          description: Detailed message explaining the resource not found error.
          example: The requested resource could not be found.
    Unauthorized:
      type: object
      properties:
        status:
          type: string
          description: Status of the response.
          example: error
        error:
          type: string
          description: Error message indicating unauthorized access.
          example: API key is not defined. Generate a new one from the developer portal.
    ServerError:
      type: object
      properties:
        status:
          type: string
          description: Status of the error.
          example: error
        type:
          type: string
          description: Type of server error.
          example: server error
        code:
          type: string
          description: Specific error code for server issues.
          example: INTERNAL_SERVER_ERROR
        message:
          type: string
          description: Detailed message explaining the issue.
          example: An internal server error occurred.
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFound'
    ValidationError:
      description: Validation error in the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
    ServerError:
      description: Indicates an internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerError'
    Unauthorized:
      description: Access to this resource is not available for unauthenticated users.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Unauthorized'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
x-provenance:
  method: harvested
  publisher: Chimoney
  source: https://api.chimoney.io/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)