Rutter Payouts API

openapi: 3.2.0
info:
  title: Rutter Payouts API
  version: '2024-08-31'
  description: The Universal API for all major e-commerce platforms, accounting systems, and payment processors.
servers:
- url: https://production.rutterapi.com/versioned
  description: Production server
- url: https://sandbox.rutterapi.com/versioned
  description: Sandbox server
tags:
- name: Payouts
paths:
  /payouts:
    get:
      summary: List commerce payouts
      operationId: listCommercePayouts
      parameters:
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/access_token'
      - name: cursor
        in: query
        required: false
        description: Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/cursor'
      - name: limit
        in: query
        required: false
        description: Used to limit the number of returned objects. Defaults to 50.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/limit'
      - name: expand
        in: query
        required: false
        description: Include platform specific data (includes additional fields not provided by the Rutter object).
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/expand'
      - name: arrival_at_max
        in: query
        required: false
        description: Used to filter objects with a `arrival_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/arrival_at_max'
      - name: arrival_at_min
        in: query
        required: false
        description: Used to filter objects with a `arrival_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/arrival_at_min'
      - name: created_at_max
        in: query
        required: false
        description: Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/created_at_max'
      - name: created_at_min
        in: query
        required: false
        description: Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/created_at_min'
      - name: source
        in: query
        required: false
        description: 'Only available for Amazon. Determines the data source for payouts. `default` uses Financial Event Groups, which includes future/pending payouts but does not include linked transactions. `settlement_report` uses Settlement Reports, which are generated by Amazon after each merchant settlement period and include all settled/historical payouts along with their linked transactions. Note: `settlement_report` requires Rutter to enable settlement report syncing for your organization. Contact the Rutter team to have this enabled. Defaults to `default`.'
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/source'
      - name: force_fetch
        in: query
        required: false
        description: Used to force a response even if the underlying connection has not finished its initial sync.
        schema:
          $ref: '#/components/schemas/ListPayoutsQuery/properties/force_fetch'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPayoutsResponse'
              examples:
                ListPayoutsResponse_Example:
                  $ref: '#/components/examples/ListPayoutsResponse_Example'
      x-supported-platforms:
      - AMAZON
      - EBAY
      - ETSY
      - MOLLIE
      - PAYPAL
      - SHEIN
      - SHOPIFY
      - SQUARE
      - STRIPE
      - WALMART
      x-sandbox-supported-platforms: []
      tags:
      - Payouts
      x-summary-source: derived
  /payouts/{id}:
    get:
      summary: Fetch commerce payout
      operationId: fetchCommercePayout
      parameters:
      - name: id
        in: path
        required: true
        description: The Rutter generated unique ID of the object.
        schema:
          $ref: '#/components/schemas/RutterIdPathParams/properties/id'
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/CommonGetParamsWithExpand/properties/access_token'
      - name: expand
        in: query
        required: false
        description: Include platform specific data (includes additional fields not provided by the Rutter object).
        schema:
          $ref: '#/components/schemas/CommonGetParamsWithExpand/properties/expand'
      - name: force_fetch
        in: query
        required: false
        description: Used to force a response even if the underlying connection has not finished its initial sync.
        schema:
          $ref: '#/components/schemas/CommonGetParamsWithExpand/properties/force_fetch'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPayoutsResponse'
              examples:
                GetPayoutsResponse_Example:
                  $ref: '#/components/examples/GetPayoutsResponse_Example'
      x-supported-platforms:
      - PAYPAL
      - STRIPE
      x-sandbox-supported-platforms: []
      tags:
      - Payouts
      x-summary-source: derived
components:
  schemas:
    ListPayoutsQuery:
      type: object
      properties:
        access_token:
          type: string
          format: uuid
          description: The access token of the connection.
        cursor:
          type: string
          description: Used to paginate to the next batch of objects. Should be a copy of the `next_cursor` value from the previous response.
        limit:
          type: integer
          description: Used to limit the number of returned objects. Defaults to 50.
        expand:
          type: array
          items:
            type: string
            enum:
            - platform_data
          description: Include platform specific data (includes additional fields not provided by the Rutter object).
        arrival_at_max:
          type: string
          description: Used to filter objects with a `arrival_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        arrival_at_min:
          type: string
          description: Used to filter objects with a `arrival_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        created_at_max:
          type: string
          description: Used to filter objects with a `created_at` value less than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        created_at_min:
          type: string
          description: Used to filter objects with a `created_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        source:
          type: string
          enum:
          - default
          - settlement_report
          description: 'Only available for Amazon. Determines the data source for payouts. `default` uses Financial Event Groups, which includes future/pending payouts but does not include linked transactions. `settlement_report` uses Settlement Reports, which are generated by Amazon after each merchant settlement period and include all settled/historical payouts along with their linked transactions. Note: `settlement_report` requires Rutter to enable settlement report syncing for your organization. Contact the Rutter team to have this enabled. Defaults to `default`.'
        force_fetch:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Used to force a response even if the underlying connection has not finished its initial sync.
      required:
      - access_token
    OrderTransaction:
      type: object
      properties:
        id:
          type: string
          description: The Rutter generated unique ID of the transaction.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            CLOVER: {}
            MOLLIE: {}
            PAYNL: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        platform_id:
          type:
          - string
          - 'null'
          description: The platform specific ID of the transaction.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            CLOVER: {}
            MOLLIE: {}
            PAYNL: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        order_id:
          type:
          - string
          - 'null'
          description: The Rutter ID of the [Order](/rest/version/orders) linked to the transaction.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            SHOPIFY: {}
            WALMART: {}
        platform_customer_id:
          type:
          - string
          - 'null'
          description: The platform specific ID of the customer linked to the transaction.
          x-rutter-platforms:
            RECHARGE: {}
            STRIPE: {}
        payment_method_type:
          type: string
          enum:
          - cash
          - card
          - other
          description: "The payment method associated with the transaction. Some enum value clarifications:\n  - `cash` - this type will mainly appear on self-hosted platforms like WooCommerce where Cash on Delivery is available.\n  - `card` - includes credit or debit card payments"
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            CLOVER: {}
            MOLLIE: {}
            PAYNL: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        status:
          type: string
          enum:
          - success
          - failure
          - pending
          - cancelled
          - refunded
          - other
          description: The status of the transaction.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            CLOVER: {}
            MOLLIE: {}
            PAYNL: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        type:
          type: string
          enum:
          - sale
          - refund
          - void
          - payout
          - fee
          - chargeback
          - chargeback_reversal
          - other
          description: "The transaction type associated with the transaction. Some enum value clarifications:\n  - `void` - means a cancellation of a pending transaction.\n  - `payout` - means the merchant transferred the money held in the platform to the merchant's own bank account.\n  - `chargeback` - a dispute withdrawal from the merchant.\n  - `chargeback_reversal` - funds returned to the merchant after a chargeback is won or released.\n  - `other` - If the transaction can't fit into any of the above types. This happens more often on self-hosted platforms where merchants create their own transaction types / have them in a different language.\n\n  The chargeback transaction types are rolling out behind platform feature flags. To avoid changing existing integrations' transaction type results, these values are only returned for connections where the rollout is enabled."
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            CLOVER: {}
            MOLLIE: {}
            PAYNL: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        amount:
          type:
          - number
          - 'null'
          description: The amount associated with the transaction.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            CLOVER: {}
            MOLLIE: {}
            PAYNL: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        fee:
          type: number
          description: The fee associated with the transaction.
          x-rutter-platforms:
            RECHARGE: {}
            SHEIN: {}
            STRIPE: {}
            WALMART: {}
        gateway:
          type:
          - string
          - 'null'
          description: The gateway associated with the transaction.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            RECHARGE: {}
            SHOPIFY: {}
            STRIPE: {}
        gateway_data:
          description: The gateway data associated with the transaction. An object containing additional metadata. This field is only populated for commerce platforms like Shopify that do their own payment processing & partner with another processor (Stripe), which attaches metadata to the transaction. Otherwise the value is `null`. The properties depend on the payment gateway used.
          type:
          - 'null'
          x-rutter-platforms:
            AMAZON: {}
            SHOPIFY: {}
            STRIPE: {}
        iso_currency_code:
          type:
          - string
          - 'null'
          description: The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the transaction.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        platform_type:
          type: string
          description: The platform type associated with the transaction.
          x-rutter-platforms:
            RECHARGE: {}
            SHEIN: {}
            WALMART: {}
        description:
          type:
          - string
          - 'null'
          description: The description of the transaction
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            SHEIN: {}
            STRIPE: {}
            WALMART: {}
        created_at:
          type: string
          description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the transaction was created.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            CLOVER: {}
            MOLLIE: {}
            PAYNL: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        updated_at:
          type: string
          description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the transaction was last updated.
          x-rutter-platforms:
            AMAZON: {}
            CLOVER: {}
            RECHARGE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        platform_data:
          type: object
          additionalProperties: {}
          description: The raw platform data corresponding to the Rutter object.
          x-rutter-platforms:
            AMAZON: {}
            SHEIN: {}
            STRIPE: {}
      required:
      - id
      - order_id
      - payment_method_type
      - status
      - type
      - amount
      - gateway
      - iso_currency_code
      - created_at
      - updated_at
      examples:
      - OrderTransaction_Example:
          $ref: '#/components/examples/OrderTransaction_Example'
    RutterIdPathParams:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The Rutter generated unique ID of the object.
      required:
      - id
    CommonGetParamsWithExpand:
      type: object
      properties:
        access_token:
          type: string
          format: uuid
          description: The access token of the connection.
        expand:
          type: array
          items:
            type: string
            enum:
            - platform_data
          description: Include platform specific data (includes additional fields not provided by the Rutter object).
        force_fetch:
          type: string
          enum:
          - 'true'
          - 'false'
          description: Used to force a response even if the underlying connection has not finished its initial sync.
      required:
      - access_token
    Connection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The UUID of the connection. Generated by Rutter.
        orgId:
          type: string
          format: uuid
          description: Your organization id.
        platform:
          $ref: '#/components/schemas/Platform'
      required:
      - id
      - orgId
      - platform
      examples:
      - Connection_Example:
          $ref: '#/components/examples/Connection_Example'
    GetPayoutsResponse:
      type: object
      properties:
        payout:
          $ref: '#/components/schemas/Payout'
          type:
          - 'null'
        connection:
          $ref: '#/components/schemas/Connection'
      required:
      - payout
      - connection
      examples:
      - GetPayoutsResponse_Example:
          $ref: '#/components/examples/GetPayoutsResponse_Example'
    Payouts:
      type: array
      items:
        $ref: '#/components/schemas/Payout'
    Platform:
      type: string
      enum:
      - AMAZON
      - EBAY
      - ETSY
      - FNAC
      - WALMART
      - SHOPEE
      - LAZADA
      - MERCADOLIBRE
      - ALIBABA
      - WAYFAIR
      - SHEIN
      - NOON
      - SHOPLINE
      - PRESTASHOP
      - SHOPIFY
      - MAGENTO
      - WOO_COMMERCE
      - SQUARESPACE
      - WIX
      - SHOPER
      - SHOPLAZZA
      - BIG_COMMERCE
      - SALLA
      - ZID
      - TIKTOKSHOP
      - COMMERCELAYER
      - WEBFLOW
      - GUMROAD
      - ECWID
      - PAYPAL
      - SQUARE
      - STRIPE
      - CLOVER
      - MOLLIE
      - PAYNL
      - AUTHORIZENET
      - RECHARGE
      - CHARGIFY
      - CHARGEBEE
      - RECURLY
      - KASHFLOW
      - SAGE_INTACCT
      - SAGE_INTACCT_V2
      - DYNAMICS365
      - DYNAMICS365FO
      - ZOHOBOOKS
      - EXACTONLINE
      - FREEAGENT
      - QUICKBOOKS
      - QUICKBOOKS_DESKTOP
      - FRESHBOOKS
      - XERO
      - SAGE_BUSINESS_CLOUD
      - SAGE_50
      - VISTA
      - NETSUITE
      - WAVE
      - DUALENTRY
      - CAMPFIRE
      - RILLET
      - SOFTLEDGER
      - VISMA
      - SPIRIS
      - LEXWARE
      - MONEYBIRD
      - SAGE200CLOUD
      - MX
      - PLAID
      - TELLER
      - RAMP
      - ODOO
      - ACUMATICA
      - FULFIL
      - TALLY
      - SAPBUSINESSONE
      - SAPS4HANA
      - WORKDAY
      - ANFIX
      - ORACLEFUSION
      - HOLDED
      - MYOBBUSINESS
      - FORTNOX
      - GOOGLE
      - FACEBOOK
      - TIKTOK
      - INTUIT_BANK_FEEDS
      - PLAID_BANK_FEEDS
      - SAGE
      - SAGE_BANK_FEEDS
      - YODLEE_BANK_FEEDS
      - QUICKBOOKS_HRIS
      - BAMBOO_HR
      - GUSTO
      - DEEL
      - RIPPLING
      description: The underlying platform.
    ListPayoutsResponse:
      type: object
      properties:
        payouts:
          $ref: '#/components/schemas/Payouts'
        next_cursor:
          type:
          - string
          - 'null'
        connection:
          $ref: '#/components/schemas/Connection'
      required:
      - payouts
      - next_cursor
      - connection
      examples:
      - ListPayoutsResponse_Example:
          $ref: '#/components/examples/ListPayoutsResponse_Example'
    Payout:
      type: object
      properties:
        id:
          type: string
          description: The Rutter generated unique ID of the payout.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        platform_id:
          type:
          - string
          - 'null'
          description: The platform specific ID of the payout.
          x-rutter-platforms:
            AMAZON: {}
            SHEIN: {}
        gateway_account_id:
          type: string
          description: The platform specific ID of the gateway associated with the payout.
          x-rutter-platforms:
            AUTHORIZENET: {}
            SHEIN: {}
            WALMART: {}
        arrival_at:
          type: string
          description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when the payout is expected to arrive.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        amount:
          type: number
          description: The total amount of money associated with the payout.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        gateway:
          type: string
          description: The gateway associated with the payout.
          x-rutter-platforms:
            SHEIN: {}
            STRIPE: {}
            WALMART: {}
        iso_currency_code:
          type: string
          description: The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code of the payout.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        schedule:
          type: string
          enum:
          - unknown
          - manual
          - automatic
          description: The schedule associated with the payout.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        status:
          type: string
          enum:
          - paid
          - pending
          - in_transit
          - cancelled
          - failed
          - refunded
          - unknown
          description: The status associated with the payout.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        type:
          type: string
          enum:
          - bank_account
          - card
          - fpx
          - unknown
          description: The type associated with the payout.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        method:
          type:
          - string
          - 'null'
          description: The method associated with the payout.
          x-rutter-platforms:
            AUTHORIZENET: {}
            STRIPE: {}
        destination:
          type:
          - object
          - 'null'
          properties:
            destination_id:
              type:
              - string
              - 'null'
              description: The platform specific ID of the payout destination.
              x-rutter-platforms:
                STRIPE: {}
            account_number_last_digits:
              type:
              - string
              - 'null'
              description: The last digits of the bank account number associated with the payout destination.
              x-rutter-platforms:
                AMAZON: {}
            bank_name:
              type:
              - string
              - 'null'
              description: The bank name associated with the payout destination
              x-rutter-platforms:
                STRIPE: {}
            brand:
              type:
              - string
              - 'null'
              description: The brand associated with the payout destination.
            last_four:
              type:
              - string
              - 'null'
              description: The last four digits of the bank account number associated with the payout destination.
              x-rutter-platforms:
                STRIPE: {}
            routing_number:
              type:
              - string
              - 'null'
              description: The brand associated with the payout destination.
              x-rutter-platforms:
                STRIPE: {}
          required:
          - destination_id
          - account_number_last_digits
          - bank_name
          - brand
          - last_four
          - routing_number
          additionalProperties: false
          description: The bank account used as the destination of the payout.
          x-rutter-platforms:
            AMAZON: {}
            MOLLIE: {}
            STRIPE: {}
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/OrderTransaction'
          description: An array of [Transactions](/rest/version/transactions) linked to the payout.
          x-rutter-platforms:
            AMAZON: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
        created_at:
          type: string
          description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the payout was created.
          x-rutter-platforms:
            AMAZON: {}
            AUTHORIZENET: {}
            MOLLIE: {}
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
            WALMART: {}
        updated_at:
          type: string
          description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the payout was last updated.
          x-rutter-platforms:
            SHEIN: {}
            SHOPIFY: {}
            STRIPE: {}
        platform_data:
          type: object
          additionalProperties: {}
          description: The raw platform data corresponding to the Rutter object.
      required:
      - id
      - gateway_account_id
      - arrival_at
      - amount
      - gateway
      - iso_currency_code
      - schedule
      - status
      - type
      - method
      - transactions
      - created_at
      - updated_at
      examples:
      - Payout_Example:
          $ref: '#/components/examples/Payout_Example'
  examples:
    OrderTransaction_Example:
      value:
        id: 00000000-0000-0000-0000-000000000000
        platform_id: '12345678'
        order_id: 00000000-0000-0000-0000-000000000000
        platform_customer_id: '12345678'
        payment_method_type: card
        status: success
        type: sale
        amount: 12.34
        fee: 1
        gateway: bank_account
        gateway_data: '123456789'
        iso_currency_code: USD
        platform_type: card
        description: For order 1234
        created_at: '2023-01-02T02:34:56.000Z'
        updated_at: '2023-01-02T02:34:56.000Z'
        platform_data:
          id: 123
          data: Varies by platform
    Payout_Example:
      value:
        id: 00000000-0000-0000-0000-000000000000
        gateway_account_id: '123456789'
        arrival_at: '2023-01-02T02:34:56.000Z'
        amount: 12.34
        gateway: bank_account
        iso_currency_code: USD
        schedule: manual
        status: paid
        type: bank_account
        method: standard
        destination:
          destination_id: '123456789'
          account_number_last_digits: '1234'
          bank_name: Wells Fargo
          brand: Wells Fargo
          last_four: '1234'
          routing_number: '123456789'
        transactions:
        - id: 00000000-0000-0000-0000-000000000000
          order_id: 00000000-0000-0000-0000-000000000000
          payment_method_type: cash
          status: success
          type: sale
          amount: 12.34
          gateway: bank_account
          gateway_data:
            platform_type: bank
            amount: 12.34
          iso_currency_code: USD
          platform_type: bank
          created_at: '2023-01-02T02:34:56.000Z'
          updated_at: '2023-01-02T02:34:56.000Z'
        created_at: '2023-01-02T02:34:56.000Z'
        updated_at: '2023-01-02T02:34:56.000Z'
    GetPayoutsResponse_Example:
      value:
        payout:
          id: 00000000-0000-0000-0000-000000000000
          gateway_account_id: '123456789'
          arrival_at: '2023-01-02T02:34:56.000Z'
          amount: 12.34
          gateway: bank_account
          iso_currency_code: USD
          schedule: manual
          status: paid
          type: bank_account
          method: standard
          destination:
            destination_id: '123456789'
            account_number_last_digits: '1234'
            bank_name: Wells Fargo
            brand: Wells Fargo
            last_four: '1234'
            routing_number: '123456789'
          transactions:
          - id: 00000000-0000-0000-0000-000000000000
            order_id: 00000000-0000-0000-0000-000000000000
            payment_method_type: cash
            status: success
            type: sale
            amount: 12.34
            gateway: bank_account
            gateway_data:
              platform_type: bank
              amount: 12.34
            iso_currency_code: USD
            platform_type: bank
            created_at: '2023-01-02T02:34:56.000Z'
            updated_at: '2023-01-02T02:34:56.000Z'
          created_at: '2023-01-02T02:34:56.000Z'
          updated_at: '2023-01-02T02:34:56.000Z'
        connection:
          id: 00000000-0000-0000-0000-000000000000
          orgId: 00000000-0000-0000-0000-000000000000
          platform: SHOPIFY
    ListPayoutsResponse_Example:
      value:
        payouts:
        - id: 00000000-0000-0000-0000-000000000000
          gateway_account_id: '123456789'
          arrival_at: '2023-01-02T02:34:56.000Z'
          amount: 12.34
          gateway: bank_account
          iso_currency_code: USD
          schedule: manual
          status: paid
          type: bank_account
          method: standard
          destination:
            destination_id: '123456789'
            account_number_last_digits: '1234'
            bank_name: Wells Fargo
            brand: Wells Fargo
            last_four: '1234'
            routing_number: '123456789'
          transactions:
          - id: 00000000-0000-0000-0000-000000000000
            order_id: 00000000-0000-0000-0000-000000000000
            payment_method_type: cash
            status: success
            type: sale
            amount: 12.34
            gateway: bank_account
            gateway_data:
              platform_type: bank
              amount: 12.34
            iso_currency_code: USD
            platform_type: bank
            created_at: '2023-01-02T02:34:56.000Z'
            updated_at: '2023-01-02T02:34:56.000Z'
          created_at: '2023-01-02T02:34:56.000Z'
          updated_at: '2023-01-02T02:34:56.000Z'
        next_cursor: MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=
        connection:
          id: 00000000-0000-0000-0000-000000000000
          orgId: 00000000-0000-0000-0000-000000000000
          platform: SHOPIFY
    Connection_Example:
      value:
        id: 00000000-0000-0000-0000-000000000000
        orgId: 00000000-0000-0000-0000-000000000000
        platform: SHOPIFY