openapi: 3.2.0
info:
  title: Sandbox Secure Refunds API
  version: 3.2.1
servers:
- url: https://api.paystand.co/v3
security:
- sec0: []
  sec1: []
  sec2: []
  sec3: []
tags:
- name: Refunds
paths:
  /refunds/all:
    get:
      summary: List all refunds
      description: Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, pagination is available with the limit and offset parameters.
      operationId: list-all-refunds
      parameters:
      - name: startDate
        in: query
        description: Filters the list based on the object "created" field, will return records whose created date is greater than or equal to the startDate.
        schema:
          type: string
          format: date
          default: '2014-01-01'
      - name: endDate
        in: query
        description: Filters the list based on the object "created" field, will return records whose created date is less than or equal to the endDate.
        schema:
          type: string
          format: date
          default: '2020-02-02'
      - name: format
        in: query
        description: 'Defines how data should be return, accepted values: ["json", "csv"]'
        schema:
          type: string
          default: json
      - name: offset
        in: query
        description: Use for pagination, how many records should the query skip
        schema:
          type: integer
          format: int32
          default: 0
      - name: limit
        in: query
        description: Defines how many values should it return, accepted value range between 1 and 200
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{ \n   \"results\":[ \n      { \n         \"object\":\"refund\",\n         \"id\":\"r5asl6ygfew3k47ixztdfka1\",\n         \"amount\":\"20.00\",\n         \"currency\":\"USD\",\n         \"settlementAmount\":\"20.00\",\n         \"settlementCurrency\":\"USD\",\n         \"paymentId\":\"e26pqmpubmlsmqak7d93vpnc\",\n         \"balanceChangeId\":\"a16609a00d5943aab4408b9b\",\n         \"description\":\"A description for the refund\",\n         \"meta\":{},\n         \"status\":\"paid\",\n         \"created\":\"2015-10-28T22:55:28.000Z\",\n         \"lastUpdated\":\"2015-10-28T22:55:30.000Z\"\n      }\n   ],\n   \"count\":1,\n   \"settings\":{ \n      \"limit\":50,\n      \"offset\":0,\n      \"order\":\"created DESC\"\n   }\n}"
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        object:
                          type: string
                          example: refund
                        id:
                          type: string
                          example: r5asl6ygfew3k47ixztdfka1
                        amount:
                          type: string
                          example: '20.00'
                        currency:
                          type: string
                          example: USD
                        settlementAmount:
                          type: string
                          example: '20.00'
                        settlementCurrency:
                          type: string
                          example: USD
                        paymentId:
                          type: string
                          example: e26pqmpubmlsmqak7d93vpnc
                        balanceChangeId:
                          type: string
                          example: a16609a00d5943aab4408b9b
                        description:
                          type: string
                          example: A description for the refund
                        meta:
                          type: object
                          properties: {}
                        status:
                          type: string
                          example: paid
                        created:
                          type: string
                          example: '2015-10-28T22:55:28.000Z'
                        lastUpdated:
                          type: string
                          example: '2015-10-28T22:55:30.000Z'
                  count:
                    type: integer
                    example: 1
                    default: 0
                  settings:
                    type: object
                    properties:
                      limit:
                        type: integer
                        example: 50
                        default: 0
                      offset:
                        type: integer
                        example: 0
                        default: 0
                      order:
                        type: string
                        example: created DESC
      deprecated: false
      tags:
      - Refunds
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