find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/aegeanbot-com:aegeanbot-com-payments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Whitelabel PMS Payments API
  version: 0.1.0
tags:
- name: Payments
paths:
  /payments/connect/onboard:
    post:
      summary: Stripe Onboard
      description: 'Create the Express account once, return the AccountLink URL for the console

        to open (envfee /connect/onboard/{host_id}).'
      operationId: stripe_onboard_payments_connect_onboard_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/connect/onboard/{owner_id}:
    get:
      summary: Stripe Onboard Resume
      description: 'AccountLink refresh target (links expire) — UNAUTH by owner id, same trust

        model as envfee: the link only lets that owner finish THEIR onboarding.'
      operationId: stripe_onboard_resume_payments_connect_onboard__owner_id__get
      parameters:
      - name: owner_id
        in: path
        required: true
        schema:
          type: string
          title: Owner Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/connect/complete/{owner_id}:
    get:
      summary: Stripe Onboard Complete
      description: 'AccountLink return target (envfee /connect/complete): re-check the account,

        persist verification (this flips payment_enabled when ready), bounce to console.'
      operationId: stripe_onboard_complete_payments_connect_complete__owner_id__get
      parameters:
      - name: owner_id
        in: path
        required: true
        schema:
          type: string
          title: Owner Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/connect/login-link:
    post:
      summary: Stripe Login Link
      description: Open the Stripe Express dashboard (single-use link, minted fresh).
      operationId: stripe_login_link_payments_connect_login_link_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/connect/status:
    get:
      summary: Stripe Status
      description: 'Live status, self-healing like envfee verify-host (re-checks Stripe and

        persists). Also returns what''s still due so the console can say why.'
      operationId: stripe_status_payments_connect_status_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/ota-stripe/status:
    get:
      summary: Ota Stripe Status
      operationId: ota_stripe_status_payments_ota_stripe_status_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/ota-stripe/{account_id}/default:
    post:
      summary: Ota Stripe Default
      operationId: ota_stripe_default_payments_ota_stripe__account_id__default_post
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/ota-stripe/connect:
    post:
      summary: Ota Stripe Connect
      description: URL for the tenant to sign in to its existing Stripe (Standard OAuth).
      operationId: ota_stripe_connect_payments_ota_stripe_connect_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/ota-stripe/callback:
    get:
      summary: Ota Stripe Callback
      description: 'Stripe OAuth return. Unauthenticated (browser redirect) — the signed,

        1-hour state names the tenant.'
      operationId: ota_stripe_callback_payments_ota_stripe_callback_get
      parameters:
      - name: state
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: State
      - name: code
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Code
      - name: error
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Error
      - name: error_description
        in: query
        required: false
        schema:
          type: string
          default: ''
          title: Error Description
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/ota-stripe/{account_id}:
    delete:
      summary: Ota Stripe Disconnect
      operationId: ota_stripe_disconnect_payments_ota_stripe__account_id__delete
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/ota-due:
    get:
      summary: Ota Payments Due
      description: Scheduled amounts due today or earlier on transferred bookings (one-click charge).
      operationId: ota_payments_due_payments_ota_due_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/transfers/process:
    post:
      summary: Stripe Process Transfers
      description: 'Scheduler/ops endpoint (envfee TRANSFER_PROCESSOR + plan T5): DRY RUN by

        default — prints the payout plan; real transfers require {"execute": true}.

        Same trust model as /events/dispatch (X-Dispatch-Secret).'
      operationId: stripe_process_transfers_payments_transfers_process_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Payments
  /payments/payouts:
    get:
      summary: Payments Payouts
      description: 'Console Payments screen: this owner''s payout history + money held,

        each with release date + approval state.'
      operationId: payments_payouts_payments_payouts_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/payouts/all:
    get:
      summary: Payments Payouts All
      description: 'Operations → Payouts: EVERY owner''s future + historical payouts.'
      operationId: payments_payouts_all_payments_payouts_all_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/payouts/{booking_id}/approve:
    post:
      summary: Approve Payout
      description: 'Manual approval gate: even past its release date, a payout only moves

        after an operator approves it here (idempotent).'
      operationId: approve_payout_payments_payouts__booking_id__approve_post
      parameters:
      - name: booking_id
        in: path
        required: true
        schema:
          type: string
          title: Booking Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
  /payments/webhook:
    post:
      summary: Stripe Webhook
      operationId: stripe_webhook_payments_webhook_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Payments
  /payments/webhook/connect:
    post:
      summary: Stripe Connect Webhook Route
      description: 'Connect webhook (account.updated on connected accounts) — flips owner

        readiness + nudges for documents without waiting for a console visit.'
      operationId: stripe_connect_webhook_route_payments_webhook_connect_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Payments
  /payments/payout-enabled:
    post:
      summary: Set Payout Enabled Route
      description: 'Ops allowlist flip (envfee payout_owners pattern): platform admins only —

        new owners stay on manual payouts until explicitly enabled here.'
      operationId: set_payout_enabled_route_payments_payout_enabled_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Payments
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError