Rentberry Rental Payments API

Rental Payments

OpenAPI Specification

rentberry-rental-payments-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Rentberry Rental Payments API
  description: Renting Done Right. Finally.
  version: 4
tags:
- name: Rental Payments
  description: Rental Payments
paths:
  /v{version}/rental/payment/account/balance:
    get:
      tags:
      - Rental Payments
      summary: Get account balance
      description: Available since API version 1. Returns the rental payment account balance for the authenticated user.
      operationId: get_api_v1_rental_payment_account
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      responses:
        '200':
          description: Account balance information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalanceResponse'
        '401':
          description: Unauthorized - Missing or invalid authentication token
      security:
      - XAuthToken: []
  /v{version}/rental/payment/account/payout:
    post:
      tags:
      - Rental Payments
      summary: Create payout
      description: Available since API version 1. Creates a Stripe payout for the authenticated user's rental payment account.
      operationId: post_api_v1_rental_payment_account_create_payout
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      responses:
        '200':
          description: Payout created successfully
          content:
            application/json:
              schema:
                properties:
                  status:
                    description: Payout status
                    type: string
                type: object
        '401':
          description: Unauthorized - Missing or invalid authentication token
        '400':
          description: Bad request - Unable to create payout
      security:
      - XAuthToken: []
components:
  schemas:
    AccountBalanceResponse:
      properties: []
      type: object