{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/rutter/json-schema/rutter-list-payouts-response-schema.json",
  "title": "ListPayoutsResponse",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rutter-payments-api-openapi.yml#/components/schemas/ListPayoutsResponse",
  "type": "object",
  "properties": {
    "payouts": {
      "$ref": "#/$defs/Payouts"
    },
    "next_cursor": {
      "type": [
        "string",
        "null"
      ]
    },
    "connection": {
      "$ref": "#/$defs/Connection"
    }
  },
  "required": [
    "payouts",
    "next_cursor",
    "connection"
  ],
  "$defs": {
    "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": "#/$defs/Platform"
        }
      },
      "required": [
        "id",
        "orgId",
        "platform"
      ]
    },
    "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"
      ]
    },
    "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": "#/$defs/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"
      ]
    },
    "Payouts": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/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."
    }
  }
}