openapi: 3.2.0
info:
  title: XRPay Cashier Connected account API
  version: '2026-08-30'
  description: 'Server-to-server API for payments, consolidated balances, bank and Mobile Money payouts, payroll, refunds, and signed webhooks. Test credentials use isolated virtual balances: a successful local-currency payment simulation can fund a test payout, and executing that payout never contacts a bank or Mobile Money network. Payment-intent amounts are integer minor units; payout and payroll amounts are exact decimal strings. Provider identities and custody allocations are never exposed.'
servers:
- url: https://api.xrpay.it
security:
- bearerAuth: []
tags:
- name: Connected account
paths:
  /api/v1/connect/account:
    get:
      tags:
      - Connected account
      summary: Retrieve the merchant connected to this access token
      operationId: retrieveConnectedAccount
      x-required-scope: account.read
      responses:
        '200':
          description: Connected merchant account
        '401':
          $ref: '#/components/responses/Error'
  /api/v1/connect/capabilities:
    get:
      tags:
      - Connected account
      summary: List ready payment methods and settlement destinations
      operationId: retrieveConnectedAccountCapabilities
      x-required-scope: account.read
      responses:
        '200':
          description: Rail-derived connected merchant capabilities
        '401':
          $ref: '#/components/responses/Error'
  /api/v1/connect/revoke:
    post:
      tags:
      - Connected account
      summary: Revoke the current platform connection
      operationId: revokeConnectedAccountConnection
      x-required-scope: account.read
      responses:
        '200':
          description: Connection revoked
        '401':
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - type
          - message
          properties:
            type:
              type: string
            code:
              type:
              - string
              - 'null'
            message:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret API key or XRPay Connect access token.