GET

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.

https://shopify.com/admin/api/2020-01/shopify_payments/payouts.json

https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout#index-2020-01

Access Token Required: API Key

Query Params

since_idstring

Filter the response to payouts made after the specified ID.

last_idstring

Filter the response to payouts made before the specified ID.

date_minstring

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

date_maxstring

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

datestring

Filter the response to payouts made on the specified date.

statusstring

Filter the response to payouts made with the specified status.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://shopify.com/admin/api/2020-01/shopify_payments/payouts.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}