openapi: 3.2.0
info:
  title: Sandbox Secure Balances API
  version: 3.2.1
servers:
- url: https://api.paystand.co/v3
security:
- sec0: []
  sec1: []
  sec2: []
  sec3: []
tags:
- name: Balances
paths:
  /balances/accounts:
    post:
      summary: Create an account
      description: ''
      operationId: create-an-account
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - key
              properties:
                name:
                  type: string
                  description: The name of the account
                  default: California Funds Account
                key:
                  type: string
                  description: A key for the account.
                  default: california_account
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\":\"h3qo5rine8itrr43wfen2356\",\n  \"object\":\"balanceAccount\",\n  \"name\": \"California Funds Account\",\n  \"key\": \"california_account\",\n  \"status\": \"active\",\n  \"created\": \"2015-10-28T22:55:09.000Z\",\n  \"lastUpdated\": \"2015-10-28T22:55:13.000Z\"\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: h3qo5rine8itrr43wfen2356
                  object:
                    type: string
                    example: balanceAccount
                  name:
                    type: string
                    example: California Funds Account
                  key:
                    type: string
                    example: california_account
                  status:
                    type: string
                    example: active
                  created:
                    type: string
                    example: '2015-10-28T22:55:09.000Z'
                  lastUpdated:
                    type: string
                    example: '2015-10-28T22:55:13.000Z'
      deprecated: false
      tags:
      - Balances
  /balances/summary:
    get:
      summary: Retrieve the balances
      description: ''
      operationId: balance-summary
      parameters:
      - name: accounts
        in: query
        description: List of accounts to show. [default, your_key]
        schema:
          type: string
          default: default
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"usd\": {\n    \"default\": {\n      \"available\": \"20.00\",\n      \"pending\": \"80.00\",\n      \"current\": \"100.00\"\n    },\n    \"california_funds\": {\n      \"available\": \"10.00\",\n      \"pending\": \"0.00\",\n      \"current\": \"10.00\" \n    }\n  }\n}"
              schema:
                type: object
                properties:
                  usd:
                    type: object
                    properties:
                      default:
                        type: object
                        properties:
                          available:
                            type: string
                            example: '20.00'
                          pending:
                            type: string
                            example: '80.00'
                          current:
                            type: string
                            example: '100.00'
                      california_funds:
                        type: object
                        properties:
                          available:
                            type: string
                            example: '10.00'
                          pending:
                            type: string
                            example: '0.00'
                          current:
                            type: string
                            example: '10.00'
      deprecated: false
      tags:
      - Balances
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: X-CUSTOMER-ID
      x-default: axjf9rjo9o6ojp5kcya7vle0
    sec1:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
      x-default: zGwAN7EfU9HYsGlcIQGGBKZ75Xug1Zdy
    sec2:
      type: apiKey
      in: header
      name: Accept
      x-default: application/json
    sec3:
      type: apiKey
      in: header
      name: Content-Type
      x-default: application/json
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://developers.paystand.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.paystand.com/reference/balance-summary.md
  - https://developers.paystand.com/reference/create-a-payer.md
  - https://developers.paystand.com/reference/create-an-account.md
  - https://developers.paystand.com/reference/create-bank.md
  - https://developers.paystand.com/reference/create-payment.md
  - https://developers.paystand.com/reference/create-withdrawal.md
  - https://developers.paystand.com/reference/get-all-payments.md
  - https://developers.paystand.com/reference/list-all-refunds.md
  - https://developers.paystand.com/reference/list-all-transfers.md
  - https://developers.paystand.com/reference/list-all-withdrawals.md
  - https://developers.paystand.com/reference/update-an-auto-withdrawal-settings.md
  merge:
    pages: 11
    deduped: 40
    conflicts_kept_first: 0