openapi: 3.2.0
info:
  title: Sandbox Secure Payers API
  version: 3.2.1
servers:
- url: https://api.paystand.co/v3
security:
- sec0: []
  sec1: []
  sec2: []
  sec3: []
tags:
- name: Payers
paths:
  /payers:
    post:
      summary: Create a payer
      description: ''
      operationId: create-a-payer
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - email
              properties:
                name:
                  type: string
                  description: The name of the payer
                  default: Christina C
                email:
                  type: string
                  description: The email of the payer
                  default: christinac@paystand.com
                address:
                  type: object
                  description: The address for the payer.
                  properties:
                    street1:
                      type: string
                      default: 123 First St
                    street2:
                      type: string
                      default: '#2'
                    city:
                      type: string
                      default: Santa Cruz
                    state:
                      type: string
                      default: CA
                    postalCode:
                      type: string
                      default: '95060'
                    country:
                      type: string
                      default: USA
                meta:
                  type: string
                  description: Optional key/values to help link a payer to an external system.
                  default: '{}'
                  format: json
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\": \"577b2ada121841e08b429444\",\n  \"object\": \"payer\",\n  \"name\": \"Christina C\",\n  \"email\": \"christinac@paystand.com\",\n  \"address\": {\n    \"id\": \"905b3a4c929c4d958092dce2\",\n    \"object\": \"address\",\n    \"street1\": \"41 Grandview St Unit C\",\n    \"city\": \"Santa Cruz\",\n    \"state\": \"CA\",\n    \"postalCode\": \"95060\",\n    \"country\": \"USA\",\n    \"status\": \"active\",\n    \"created\": \"2018-08-07T20:07:14.000Z\",\n    \"lastUpdated\": \"2018-08-07T20:07:14.000Z\"\n  },\n  \"status\": \"active\",\n  \"created\": \"2018-08-07T20:07:14.000Z\",\n  \"lastUpdated\": \"2018-08-07T20:07:14.000Z\"\n}"
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: 577b2ada121841e08b429444
                  object:
                    type: string
                    example: payer
                  name:
                    type: string
                    example: Christina C
                  email:
                    type: string
                    example: christinac@paystand.com
                  address:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 905b3a4c929c4d958092dce2
                      object:
                        type: string
                        example: address
                      street1:
                        type: string
                        example: 41 Grandview St Unit C
                      city:
                        type: string
                        example: Santa Cruz
                      state:
                        type: string
                        example: CA
                      postalCode:
                        type: string
                        example: '95060'
                      country:
                        type: string
                        example: USA
                      status:
                        type: string
                        example: active
                      created:
                        type: string
                        example: '2018-08-07T20:07:14.000Z'
                      lastUpdated:
                        type: string
                        example: '2018-08-07T20:07:14.000Z'
                  status:
                    type: string
                    example: active
                  created:
                    type: string
                    example: '2018-08-07T20:07:14.000Z'
                  lastUpdated:
                    type: string
                    example: '2018-08-07T20:07:14.000Z'
      deprecated: false
      tags:
      - Payers
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