Square Payouts API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Payouts API
  description: 'Supercharge Square for sellers of every size. Our entire connected commerce platform  from elegant hardware to a rich suite of Square APIs  is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. '
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:
- name: Payouts
paths:
  /v2/payouts:
    get:
      tags:
      - Payouts
      summary: Square List Payouts
      operationId: ListPayouts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a list of all payouts for the default location.

        You can filter payouts by location ID, status, time range, and order them in ascending or descending order.

        To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.'
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: location_id
        description: 'The ID of the location for which to list the payouts.

          By default, payouts are returned for the default (main) location associated with the seller.'
        schema:
          type: string
        in: query
        required: false
      - name: status
        description: If provided, only payouts with the given status are returned.
        schema:
          $ref: '#/components/schemas/PayoutStatus'
        in: query
        required: false
      - name: begin_time
        description: 'The timestamp for the beginning of the payout creation time, in RFC 3339 format.

          Inclusive. Default: The current time minus one year.'
        schema:
          type: string
        in: query
        required: false
      - name: end_time
        description: 'The timestamp for the end of the payout creation time, in RFC 3339 format.

          Default: The current time.'
        schema:
          type: string
        in: query
        required: false
      - name: sort_order
        description: The order in which payouts are listed.
        schema:
          $ref: '#/components/schemas/SortOrder'
        in: query
        required: false
      - name: cursor
        description: 'A pagination cursor returned by a previous call to this endpoint.

          Provide this cursor to retrieve the next set of results for the original query.

          For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

          If request parameters change between requests, subsequent results may contain duplicates or missing records.'
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: 'The maximum number of results to be returned in a single page.

          It is possible to receive fewer results than the specified limit on a given page.

          The default value of 100 is also the maximum allowed value. If the provided value is

          greater than 100, it is ignored and the default value is used instead.

          Default: `100`'
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPayoutsResponse'
  /v2/payouts/{payout_id}:
    get:
      tags:
      - Payouts
      summary: Square Get Payout
      operationId: GetPayout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves details of a specific payout identified by a payout ID.

        To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.'
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: payout_id
        description: The ID of the payout to retrieve the information for.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPayoutResponse'
  /v2/payouts/{payout_id}/payout-entries:
    get:
      tags:
      - Payouts
      summary: Square List Payout Entries
      operationId: ListPayoutEntries
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a list of all payout entries for a specific payout.

        To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.'
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: payout_id
        description: The ID of the payout to retrieve the information for.
        schema:
          type: string
        in: path
        required: true
      - name: sort_order
        description: The order in which payout entries are listed.
        schema:
          $ref: '#/components/schemas/SortOrder'
        in: query
        required: false
      - name: cursor
        description: 'A pagination cursor returned by a previous call to this endpoint.

          Provide this cursor to retrieve the next set of results for the original query.

          For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

          If request parameters change between requests, subsequent results may contain duplicates or missing records.'
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: 'The maximum number of results to be returned in a single page.

          It is possible to receive fewer results than the specified limit on a given page.

          The default value of 100 is also the maximum allowed value. If the provided value is

          greater than 100, it is ignored and the default value is used instead.

          Default: `100`'
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPayoutEntriesResponse'
components:
  schemas:
    Currency:
      type: string
      enum:
      - UNKNOWN_CURRENCY
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYR
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SLE
      - SOS
      - SRD
      - SSP
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - USS
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XTS
      - XXX
      - YER
      - ZAR
      - ZMK
      - ZMW
      - BTC
      - XUS
      x-enum-elements:
      - name: UNKNOWN_CURRENCY
        description: Unknown currency
      - name: AED
        description: United Arab Emirates dirham
      - name: AFN
        description: Afghan afghani
      - name: ALL
        description: Albanian lek
      - name: AMD
        description: Armenian dram
      - name: ANG
        description: Netherlands Antillean guilder
      - name: AOA
        description: Angolan kwanza
      - name: ARS
        description: Argentine peso
      - name: AUD
        description: Australian dollar
      - name: AWG
        description: Aruban florin
      - name: AZN
        description: Azerbaijani manat
      - name: BAM
        description: Bosnia and Herzegovina convertible mark
      - name: BBD
        description: Barbados dollar
      - name: BDT
        description: Bangladeshi taka
      - name: BGN
        description: Bulgarian lev
      - name: BHD
        description: Bahraini dinar
      - name: BIF
        description: Burundian franc
      - name: BMD
        description: Bermudian dollar
      - name: BND
        description: Brunei dollar
      - name: BOB
        description: Boliviano
      - name: BOV
        description: Bolivian Mvdol
      - name: BRL
        description: Brazilian real
      - name: BSD
        description: Bahamian dollar
      - name: BTN
        description: Bhutanese ngultrum
      - name: BWP
        description: Botswana pula
      - name: BYR
        description: Belarusian ruble
      - name: BZD
        description: Belize dollar
      - name: CAD
        description: Canadian dollar
      - name: CDF
        description: Congolese franc
      - name: CHE
        description: WIR Euro
      - name: CHF
        description: Swiss franc
      - name: CHW
        description: WIR Franc
      - name: CLF
        description: Unidad de Fomento
      - name: CLP
        description: Chilean peso
      - name: CNY
        description: Chinese yuan
      - name: COP
        description: Colombian peso
      - name: COU
        description: Unidad de Valor Real
      - name: CRC
        description: Costa Rican colon
      - name: CUC
        description: Cuban convertible peso
      - name: CUP
        description: Cuban peso
      - name: CVE
        description: Cape Verdean escudo
      - name: CZK
        description: Czech koruna
      - name: DJF
        description: Djiboutian franc
      - name: DKK
        description: Danish krone
      - name: DOP
        description: Dominican peso
      - name: DZD
        description: Algerian dinar
      - name: EGP
        description: Egyptian pound
      - name: ERN
        description: Eritrean nakfa
      - name: ETB
        description: Ethiopian birr
      - name: EUR
        description: Euro
      - name: FJD
        description: Fiji dollar
      - name: FKP
        description: Falkland Islands pound
      - name: GBP
        description: Pound sterling
      - name: GEL
        description: Georgian lari
      - name: GHS
        description: Ghanaian cedi
      - name: GIP
        description: Gibraltar pound
      - name: GMD
        description: Gambian dalasi
      - name: GNF
        description: Guinean franc
      - name: GTQ
        description: Guatemalan quetzal
      - name: GYD
        description: Guyanese dollar
      - name: HKD
        description: Hong Kong dollar
      - name: HNL
        description: Honduran lempira
      - name: HRK
        description: Croatian kuna
      - name: HTG
        description: Haitian gourde
      - name: HUF
        description: Hungarian forint
      - name: IDR
        description: Indonesian rupiah
      - name: ILS
        description: Israeli new shekel
      - name: INR
        description: Indian rupee
      - name: IQD
        description: Iraqi dinar
      - name: IRR
        description: Iranian rial
      - name: ISK
        description: Icelandic króna
      - name: JMD
        description: Jamaican dollar
      - name: JOD
        description: Jordanian dinar
      - name: JPY
        description: Japanese yen
      - name: KES
        description: Kenyan shilling
      - name: KGS
        description: Kyrgyzstani som
      - name: KHR
        description: Cambodian riel
      - name: KMF
        description: Comoro franc
      - name: KPW
        description: North Korean won
      - name: KRW
        description: South Korean won
      - name: KWD
        description: Kuwaiti dinar
      - name: KYD
        description: Cayman Islands dollar
      - name: KZT
        description: Kazakhstani tenge
      - name: LAK
        description: Lao kip
      - name: LBP
        description: Lebanese pound
      - name: LKR
        description: Sri Lankan rupee
      - name: LRD
        description: Liberian dollar
      - name: LSL
        description: Lesotho loti
      - name: LTL
        description: Lithuanian litas
      - name: LVL
        description: Latvian lats
      - name: LYD
        description: Libyan dinar
      - name: MAD
        description: Moroccan dirham
      - name: MDL
        description: Moldovan leu
      - name: MGA
        description: Malagasy ariary
      - name: MKD
        description: Macedonian denar
      - name: MMK
        description: Myanmar kyat
      - name: MNT
        description: Mongolian tögrög
      - name: MOP
        description: Macanese pataca
      - name: MRO
        description: Mauritanian ouguiya
      - name: MUR
        description: Mauritian rupee
      - name: MVR
        description: Maldivian rufiyaa
      - name: MWK
        description: Malawian kwacha
      - name: MXN
        description: Mexican peso
      - name: MXV
        description: Mexican Unidad de Inversion
      - name: MYR
        description: Malaysian ringgit
      - name: MZN
        description: Mozambican metical
      - name: NAD
        description: Namibian dollar
      - name: NGN
        description: Nigerian naira
      - name: NIO
        description: Nicaraguan córdoba
      - name: NOK
        description: Norwegian krone
      - name: NPR
        description: Nepalese rupee
      - name: NZD
        description: New Zealand dollar
      - name: OMR
        description: Omani rial
      - name: PAB
        description: Panamanian balboa
      - name: PEN
        description: Peruvian sol
      - name: PGK
        description: Papua New Guinean kina
      - name: PHP
        description: Philippine peso
      - name: PKR
        description: Pakistani rupee
      - name: PLN
        description: Polish zBoty
      - name: PYG
        description: Paraguayan guaraní
      - name: QAR
        description: Qatari riyal
      - name: RON
        description: Romanian leu
      - name: RSD
        description: Serbian dinar
      - name: RUB
        description: Russian ruble
      - name: RWF
        description: Rwandan franc
      - name: SAR
        description: Saudi riyal
      - name: SBD
        description: Solomon Islands dollar
      - name: SCR
        description: Seychelles rupee
      - name: SDG
        description: Sudanese pound
      - name: SEK
        description: Swedish krona
      - name: SGD
        description: Singapore dollar
      - name: SHP
        description: Saint Helena pound
      - name: SLL
        description: Sierra Leonean first leone
      - name: SLE
        description: Sierra Leonean second leone
      - name: SOS
        description: Somali shilling
      - name: SRD
        description: Surinamese dollar
      - name: SSP
        description: South Sudanese pound
      - name: STD
        description: São Tomé and Príncipe dobra
      - name: SVC
        description: Salvadoran colón
      - name: SYP
        description: Syrian pound
      - name: SZL
        description: Swazi lilangeni
      - name: THB
        description: Thai baht
      - name: TJS
        description: Tajikstani somoni
      - name: TMT
        description: Turkmenistan manat
      - name: TND
        description: Tunisian dinar
      - name: TOP
        description: Tongan pa'anga
      - name: TRY
        description: Turkish lira
      - name: TTD
        description: Trinidad and Tobago dollar
      - name: TWD
        description: New Taiwan dollar
      - name: TZS
        description: Tanzanian shilling
      - name: UAH
        description: Ukrainian hryvnia
      - name: UGX
        description: Ugandan shilling
      - name: USD
        description: United States dollar
      - name: USN
        description: United States dollar (next day)
      - name: USS
        description: United States dollar (same day)
      - name: UYI
        description: Uruguay Peso en Unidedades Indexadas
      - name: UYU
        description: Uruguyan peso
      - name: UZS
        description: Uzbekistan som
      - name: VEF
        description: Venezuelan bolívar soberano
      - name: VND
        description: Vietnamese ’Óng
      - name: VUV
        description: Vanuatu vatu
      - name: WST
        description: Samoan tala
      - name: XAF
        description: CFA franc BEAC
      - name: XAG
        description: Silver
      - name: XAU
        description: Gold
      - name: XBA
        description: European Composite Unit
      - name: XBB
        description: European Monetary Unit
      - name: XBC
        description: European Unit of Account 9
      - name: XBD
        description: European Unit of Account 17
      - name: XCD
        description: East Caribbean dollar
      - name: XDR
        description: Special drawing rights (International Monetary Fund)
      - name: XOF
        description: CFA franc BCEAO
      - name: XPD
        description: Palladium
      - name: XPF
        description: CFP franc
      - name: XPT
        description: Platinum
      - name: XTS
        description: Code reserved for testing
      - name: XXX
        description: No currency
      - name: YER
        description: Yemeni rial
      - name: ZAR
        description: South African rand
      - name: ZMK
        description: Zambian kwacha
      - name: ZMW
        description: Zambian kwacha
      - name: BTC
        description: Bitcoin
      - name: XUS
        description: USD Coin
      description: 'Indicates the associated currency for an amount of money. Values correspond

        to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).'
      x-release-status: PUBLIC
    PaymentBalanceActivityDisputeDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
        dispute_id:
          type:
          - string
          - 'null'
          description: The ID of the dispute associated with this activity.
    GetPayoutResponse:
      type: object
      x-release-status: PUBLIC
      properties:
        payout:
          $ref: '#/components/schemas/Payout'
          description: The requested payout.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Information about errors encountered during the request.
      example:
        payout:
          amount_money:
            amount: -103
            currency_code: USD
          arrival_date: '2022-03-24'
          created_at: '2022-03-24T03:07:09Z'
          destination:
            id: bact:ZPp3oedR3AeEUNd3z7
            type: BANK_ACCOUNT
          id: po_f3c0fb38-a5ce-427d-b858-52b925b72e45
          location_id: L88917AVBK2S5
          status: PAID
          type: BATCH
          updated_at: '2022-03-24T03:07:09Z'
          version: 1
    PayoutFee:
      type: object
      description: Represents a payout fee that can incur as part of a payout.
      x-release-status: PUBLIC
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
          description: The money amount of the payout fee.
        effective_at:
          type:
          - string
          - 'null'
          description: The timestamp of when the fee takes effect, in RFC 3339 format.
        type:
          $ref: '#/components/schemas/PayoutFeeType'
          description: 'The type of fee assessed as part of the payout.

            See [PayoutFeeType](#type-payoutfeetype) for possible values'
    PayoutStatus:
      type: string
      enum:
      - SENT
      - FAILED
      - PAID
      x-enum-elements:
      - name: SENT
        description: Indicates that the payout was successfully sent to the banking destination.
      - name: FAILED
        description: Indicates that the payout was rejected by the banking destination.
      - name: PAID
        description: Indicates that the payout has successfully completed.
      description: Payout status types
      x-release-status: PUBLIC
    PayoutFeeType:
      type: string
      enum:
      - TRANSFER_FEE
      - TAX_ON_TRANSFER_FEE
      x-enum-elements:
      - name: TRANSFER_FEE
        description: Fee type associated with transfers.
      - name: TAX_ON_TRANSFER_FEE
        description: Taxes associated with the transfer fee.
      description: Represents the type of payout fee that can incur as part of a payout.
      x-release-status: PUBLIC
    PaymentBalanceActivityOtherAdjustmentDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
    PaymentBalanceActivityTaxOnFeeDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
        tax_rate_description:
          type:
          - string
          - 'null'
          description: 'The description of the tax rate being applied. For example: "GST", "HST".'
    PaymentBalanceActivityAutomaticSavingsReversedDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
        payout_id:
          type:
          - string
          - 'null'
          description: The ID of the payout associated with this activity.
    PaymentBalanceActivityHoldAdjustmentDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
    PaymentBalanceActivitySquarePayrollTransferReversedDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
    Money:
      type: object
      description: 'Represents an amount of money. `Money` fields can be signed or unsigned.

        Fields that do not explicitly define whether they are signed or unsigned are

        considered unsigned and can only hold positive amounts. For signed fields, the

        sign of the value indicates the purpose of the money transfer. See

        [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)

        for more information.'
      x-release-status: PUBLIC
      properties:
        amount:
          type:
          - integer
          - 'null'
          description: 'The amount of money, in the smallest denomination of the currency

            indicated by `currency`. For example, when `currency` is `USD`, `amount` is

            in cents. Monetary amounts can be positive or negative. See the specific

            field description to determine the meaning of the sign in a particular case.'
          format: int64
        currency:
          $ref: '#/components/schemas/Currency'
          description: 'The type of currency, in __ISO 4217 format__. For example, the currency

            code for US dollars is `USD`.


            See [Currency](entity:Currency) for possible values.

            See [Currency](#type-currency) for possible values'
    ListPayoutEntriesResponse:
      type: object
      description: The response to retrieve payout records entries.
      x-release-status: PUBLIC
      properties:
        payout_entries:
          type: array
          items:
            $ref: '#/components/schemas/PayoutEntry'
          description: The requested list of payout entries, ordered with the given or default sort order.
        cursor:
          type: string
          description: 'The pagination cursor to be used in a subsequent request. If empty, this is the final response.

            For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Information about errors encountered during the request.
      example:
        cursor: TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO
        payout_entries:
        - effective_at: '2021-12-14T23:31:49Z'
          fee_amount_money:
            amount: -2
            currency_code: USD
          gross_amount_money:
            amount: -50
            currency_code: USD
          id: poe_ZQWcw41d0SGJS6IWd4cSi8mKHk
          net_amount_money:
            amount: -48
            currency_code: USD
          payout_id: po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6
          type: REFUND
          type_refund_details:
            payment_id: HVdG62HeMlti8YYf94oxrN
            refund_id: HVdG62HeMlti8YYf94oxrN_dR8Nztxg7umf94oxrN12Ji5r2KW14FAY
        - effective_at: '2021-12-14T23:31:49Z'
          fee_amount_money:
            amount: 19
            currency_code: USD
          gross_amount_money:
            amount: 100
            currency_code: USD
          id: poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk
          net_amount_money:
            amount: 81
            currency_code: USD
          payout_id: po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6
          type: CHARGE
          type_charge_details:
            payment_id: HVdG62H5K3291d0SGJS6IWd4cSi8YY
    PaymentBalanceActivityReserveReleaseDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
    PaymentBalanceActivityReserveHoldDetail:
      type: object
      x-release-status: PUBLIC
      properties:
        payment_id:
          type:
          - string
          - 'null'
          description: The ID of the payment associated with this activity.
    Payout:
      type: object
      description: 'An accounting of the amount owed the seller and record of the actual transfer to their

        external bank account or to the Square balance.'
      x-release-status: PUBLIC
      required:
      - id
      - location_id
      properties:
        id:
          type: string
          description: A unique ID for the payout.
          minLength: 1
        status:
          $ref: '#/components/schemas/PayoutStatus'
          description: 'Indicates the payout status.

            See [PayoutStatus](#type-payoutstatus) for possible values'
        location_id:
          type: string
          description: The ID of the location associated with the payout.
          minLength: 1
        created_at:
          type: string
          description: The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format.
        updated_at:
          type: string
          description: The timestamp of when the payout was last updated, in RFC 3339 format.
        amount_money:
          $ref: '#/components/schemas/Money'
          description: The amount of money involved in the payout. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero.
        destination:
          $ref: '#/components/schemas/Destination'
          description: 'Information about the banking destination (such as a bank account, Square checking account, or debit card)

            against which the payout was made.'
        version:
          type: integer
          description: 'The version number, which is incremented each time an update is made to this payout record.

            The version number helps developers receive event notifications or feeds out of order.'
        type:
          $ref: '#/components/schemas/PayoutType'
          description: 'Indicates the payout type.

            See [PayoutType](#type-payouttype) for possible values'
        payout_fee:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PayoutFee'
          description: A list of transfer fees and any taxes on the fees assessed by Square for this payout.
        arrival_date:
          type:
          - string
          - 'null'
          description: The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination.
        end_to_end_id:
          type:
          - string
          - 'null'
          description: A unique ID for each `Payout` object that might also appear on the seller’s ba

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-payouts-api-openapi.yml