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
id
stringThe Rutter generated unique ID of the payout.
gateway_account_id
stringThe platform specific ID of the gateway associated with the payout..
arrival_at
stringThe ISO 8601 timestamp that the payout is expected to arrive.
amount
numberThe total amount of money associated with the payout.
gateway
stringThe gateway associated with the payout.
iso_currency_code
stringThe ISO 4217 currency code of the payout.
schedule
enumThe schedule associated with the payout.
status
enumThe status associated with the payout.
type
enumThe type associated with the payout.
method
stringnullableThe method associated with the payout.
destination
objectnullableoptionalThe bank account used as the destination of the payout.
destination
attributescreated_at
stringThe ISO 8601 timestamp that the payout was created.
updated_at
stringThe ISO 8601 timestamp that the payout was last updated.
{
"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 /payoutsRequest Parameters
access_token
stringqueryThe access token of the connection.
arrival_at_max
stringoptionalqueryUnix Timestamp in milliseconds representing the maximum arrival_at datetime to fetch entities from.
arrival_at_min
stringoptionalqueryUnix Timestamp in milliseconds representing the minimum arrival_at datetime to fetch entities from.
created_at_max
stringoptionalqueryUnix Timestamp in milliseconds representing the maximum created_at datetime to fetch entities from.
created_at_min
stringoptionalqueryUnix Timestamp in milliseconds representing the minimum created_at datetime to fetch entities from.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributespayouts
arraypayouts
attributesnext_cursor
stringnullable{
"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="
}