Version 2019-10
Payouts represent the movement of money between a Shopify Payments account balance and a connected bank account.

What you can do with Payouts

The Shopify API lets you do the following with the Payouts resource. More detailed versions of these general actions may be available:

Payouts properties

"id": 54534554564

The unique identifier of the payout

"status": "scheduled"

The transfer status of the payout. The value will be one of the following:

  • scheduled: The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.
  • in_transit: The payout has been submitted to the bank for processing.
  • paid: The payout has been successfully deposited into the bank.
  • failed: The payout has been declined by the bank.
  • canceled: The payout has been canceled by Shopify.

"date": "2018-03-22"

The date (ISO 8601 format) when the payout was issued.

"currency": "USD"

The ISO 4217 currency code of the payout.

"amount": "102.53"

The total amount of the payout, in a decimal formatted string.


GET /admin/api/2019-10/shopify_payments/payouts.json
Retrieves a list of all payouts ordered by payout date, with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

Filter the response to payouts made after the specified ID.


Filter the response to payouts made before the specified ID.


Filter the response to payouts made inclusively after the specified date.


Filter the response to payouts made inclusively before the specified date.


Filter the response to payouts made on the specified date.


Filter the response to payouts made with the specified status.