Payouts

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.

platform_idstringnullableOptional

The platform specific ID of the payout.

gateway_account_idstring

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

arrival_atstring

The ISO 8601 timestamp for when 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.

platform_dataobjectOptional
Endpoints
GET
/payouts

List Payouts

GEThttps://production.rutterapi.com/versioned/payouts

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    expandstringqueryOptional

    Optionally, include raw data from platform when returning payouts data.

    arrival_at_maxstringqueryOptional

    Used to filter objects with a arrival_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    arrival_at_minstringqueryOptional

    Used to filter objects with a arrival_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    created_at_maxstringqueryOptional

    Used to filter objects with a created_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    created_at_minstringqueryOptional

    Used to filter objects with a created_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "payouts": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "gateway_account_id": "123456789",


6
      "arrival_at": "2023-01-02T02:34:56.000Z",


7
      "amount": 12.34,


8
      "gateway": "bank_account",


9
      "iso_currency_code": "USD",


10
      "schedule": "manual",


11
      "status": "paid",


12
      "type": "bank_account",


13
      "method": "standard",


14
      "destination": {


15
        "destination_id": "123456789",


16
        "account_number_last_digits": "1234",


17
        "bank_name": "Wells Fargo",


18
        "brand": "Wells Fargo",


19
        "last_four": "1234",


20
        "routing_number": "123456789"


21
      },


22
      "transactions": [


23
        {


24
          "id": "00000000-0000-0000-0000-000000000000",


25
          "order_id": "00000000-0000-0000-0000-000000000000",


26
          "payment_method_type": "cash",


27
          "status": "success",


28
          "type": "sale",


29
          "amount": 12.34,


30
          "gateway": "bank_account",


31
          "gateway_data": {


32
            "platform_type": "bank",


33
            "amount": 12.34


34
          },


35
          "iso_currency_code": "USD",


36
          "platform_type": "bank",


37
          "created_at": "2023-01-02T02:34:56.000Z",


38
          "updated_at": "2023-01-02T02:34:56.000Z"


39
        }


40
      ],


41
      "created_at": "2023-01-02T02:34:56.000Z",


42
      "updated_at": "2023-01-02T02:34:56.000Z"


43
    }


44
  ],


45
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


46
  "connection": {


47
    "id": "00000000-0000-0000-0000-000000000000",


48
    "orgId": "00000000-0000-0000-0000-000000000000",


49
    "platform": "SHOPIFY"


50
  }


51
}

Have questions?

Contact support for personalized guidance.

Contact support
Previous
Balance
Next
Subscriptions