Payouts

A Rutter Payout represents a transfer of funds from a merchant's storefront account to their linked bank. Each payout object contains multiple linked Rutter Transaction objects.

Property

Type

Description

id

string

The Rutter ID of the payout. This value is a UUID generated by Rutter that uniquely identifies a payout regardless of platforms.

amount

number

iso_currency_code

string

The ISO-4217 currency code of the payout.

destination

object

The destination of the payout. Contains the following properties: account_number_last_digits, bank_name, destination_id, last_four, routing_number

gateway

string

gateway_account_id

string

method

string

Available for stripe only. One of:

  • standard
  • instant

schedule

string

One of:

  • unknown
  • manual
  • automatic

status

string

One of:

  • paid
  • pending
  • in_transit
  • cancelled
  • failed

transactions

Transactions []

A list of associated Rutter Transaction objects. Currently, this field will be empty for Amazon.

type

string

One of:

  • bank_account
  • card

arrival_at

string

The ISO 8601 timestamp that the payout will arrive at the destination

created_at

string

The ISO 8601 timestamp that the payout is created

updated_at

string

The ISO 8601 timestamp that the payout is updated

Platform Differences

There can be some differences in field values due to platform-specific limitations or if the connection is missing required scopes.

transactions

Amazon: Currently, this field will be empty for Amazon