Commerce

Payouts
Get API Keys

The Payout object

A Rutter Payout represents a movement of money from the commerce or payments platform into the merchant's original cash account. Payouts are a subtype of a Transaction, and every payout is linked to multiple Transactions that represent successful charges transferred as part of the payout.

Properties

idstring

The Rutter generated unique ID of the payout.

gateway_account_idstring

The platform specific ID of the gateway associated with the payout..

arrival_atstring

The ISO 8601 timestamp that the payout is expected to arrive.

amountnumber

The total amount of money associated with the payout.

gatewaystring

The gateway associated with the payout.

iso_currency_codestring

The ISO 4217 currency code of the payout.

scheduleenum

The schedule associated with the payout.

One ofunknown, manual, or automatic.
statusenum

The status associated with the payout.

One ofpaid, pending, in_transit, cancelled, failed, refunded, or unknown.
typeenum

The type associated with the payout.

One ofbank_account, card, fpx, or unknown.
methodstringnullable

The method associated with the payout.

destinationobjectnullableoptional

The bank account used as the destination of the payout.

Show destination attributes
transactionsarray

An array of Transactions linked to the payout.

Show transactions attributes
created_atstring

The ISO 8601 timestamp that the payout was created.

updated_atstring

The ISO 8601 timestamp that the payout was last updated.

Example Payout Object
{
  "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"
}

List Payouts

GET /payouts
Supported for: AmazonEbayPayPalShopifySquareStripe

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    arrival_at_maxstringoptionalquery
    arrival_at_minstringoptionalquery
    created_at_maxstringoptionalquery
    created_at_minstringoptionalquery
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    payoutsarray
    Show payouts attributes
    next_cursorstringnullable
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "SHOPIFY"
  },
  "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="
}
Next
Overview