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
id
stringRequiredThe Rutter generated unique ID of the payout.
gateway_account_id
stringRequiredThe platform specific ID of the gateway associated with the payout..
arrival_at
stringRequiredThe ISO 8601 timestamp that the payout is expected to arrive.
amount
numberRequiredThe total amount of money associated with the payout.
gateway
stringRequiredThe gateway associated with the payout.
iso_currency_code
stringRequiredThe ISO 4217 currency code of the payout.
schedule
enumRequiredThe schedule associated with the payout.
status
enumRequiredThe status associated with the payout.
type
enumRequiredThe type associated with the payout.
method
stringnullableRequiredThe method associated with the payout.
destination
objectnullableThe bank account used as the destination of the payout.
destination
attributescreated_at
stringRequiredThe ISO 8601 timestamp that the payout was created.
updated_at
stringRequiredThe ISO 8601 timestamp that the payout was last updated.
List Payouts
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
arrival_at_max
stringqueryUnix Timestamp in milliseconds representing the maximum arrival_at datetime to fetch entities from.
arrival_at_min
stringqueryUnix Timestamp in milliseconds representing the minimum arrival_at datetime to fetch entities from.
created_at_max
stringqueryUnix Timestamp in milliseconds representing the maximum created_at datetime to fetch entities from.
created_at_min
stringqueryUnix Timestamp in milliseconds representing the minimum created_at datetime to fetch entities from.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectRequiredconnection
attributespayouts
arrayRequiredpayouts
attributesnext_cursor
stringnullableRequired- Amazon
- Big Commerce
- Clover
- Ebay
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "SHOPIFY"
6 },
7 "payouts": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "gateway_account_id": "123456789",
11 "arrival_at": "2023-01-02T02:34:56.000Z",
12 "amount": 12.34,
13 "gateway": "bank_account",
14 "iso_currency_code": "USD",
15 "schedule": "manual",
16 "status": "paid",
17 "type": "bank_account",
18 "method": "standard",
19 "destination": {
20 "destination_id": "123456789",
21 "account_number_last_digits": "1234",
22 "bank_name": "Wells Fargo",
23 "brand": "Wells Fargo",
24 "last_four": "1234",
25 "routing_number": "123456789"
26 },
27 "transactions": [
28 {
29 "id": "00000000-0000-0000-0000-000000000000",
30 "order_id": "00000000-0000-0000-0000-000000000000",
31 "payment_method_type": "cash",
32 "status": "success",
33 "type": "sale",
34 "amount": 12.34,
35 "gateway": "bank_account",
36 "gateway_data": {
37 "platform_type": "bank",
38 "amount": 12.34
39 },
40 "iso_currency_code": "USD",
41 "platform_type": "bank",
42 "created_at": "2023-01-02T02:34:56.000Z",
43 "updated_at": "2023-01-02T02:34:56.000Z"
44 }
45 ],
46 "created_at": "2023-01-02T02:34:56.000Z",
47 "updated_at": "2023-01-02T02:34:56.000Z"
48 }
49 ],
50 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
51}
Have questions?
Contact support for personalized guidance.