Skip to main content

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Payouts

Requires ANY of the following access scopes: shopify_payments_payouts, shopify_payments.

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

Was this section helpful?
#

Endpoints

Anchor to

The Payouts resource

Anchor to

Properties

id
->
id

The unique identifier of the payout

status
->
status

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

Show status properties
  • 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
->
issuedAt

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

currency
->
currencyCode

The ISO 4217 currency code of the payout.

amount
->
amount

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

Was this section helpful?
{}

The Payouts resource

{
"id": 54534554564,
"status": "scheduled",
"date": "2018-03-22",
"currency": "USD",
"amount": "102.53"
}

Anchor to GET request, Return a list of all payouts
get
Return a list of all payouts

shopifyPaymentsAccount

Retrieves a list of all payouts ordered by payout date, with the most recent being first. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.

Anchor to Parameters of Return a list of all payoutsParameters

api_version
string
required
date

Filter the response to payouts made on the specified date.

date_max

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

date_min

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

last_id

Filter the response to payouts made before the specified ID.

since_id

Filter the response to payouts made after the specified ID.

status

Filter the response to payouts made with the specified status.

Was this section helpful?

Anchor to get-shopify-payments-payouts-examplesExamples

List all payouts ordered newest to oldest

List all payouts up to a specified date

Query parameters
date_max=2012-11-12

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

Was this section helpful?
get

/admin/api/2025-07/shopify_payments/payouts.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/payouts.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"payouts": [
{
"id": 512467833,
"status": "failed",
"date": "2013-12-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
},
{
"id": 39438702,
"status": "in_transit",
"date": "2013-11-01",
"currency": "USD",
"amount": "43.12",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "45.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",

Anchor to GET request, Return a single payout
get
Return a single payout

shopifyPaymentsAccount

Retrieves a single payout by id.

Anchor to Parameters of Return a single payoutParameters

api_version
string
required
payout_id
string
required
Was this section helpful?

Anchor to get-shopify-payments-payouts-payout-id-examplesExamples

Retrieves a single payout by id

Path parameters
payout_id=623721858
string
required
Was this section helpful?
get

/admin/api/2025-07/shopify_payments/payouts/623721858.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/payouts/623721858.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"payout": {
"id": 623721858,
"status": "paid",
"date": "2012-11-12",
"currency": "USD",
"amount": "41.90",
"summary": {
"adjustments_fee_amount": "0.12",
"adjustments_gross_amount": "2.13",
"charges_fee_amount": "1.32",
"charges_gross_amount": "44.52",
"refunds_fee_amount": "-0.23",
"refunds_gross_amount": "-3.54",
"reserved_funds_fee_amount": "0.00",
"reserved_funds_gross_amount": "0.00",
"retried_payouts_fee_amount": "0.00",
"retried_payouts_gross_amount": "0.00"
}
}
}