The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

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?
Anchor to section titled 'The Payouts resource'

The Payouts resource

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:
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 section titled '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 section titled 'Parameters of Return a list of all payouts'

Parameters

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 section titled 'Examples of Return a list of all payouts'

Examples

Was this section helpful?
get
/admin/api/2024-10/shopify_payments/payouts.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/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",
        "reserved_funds_gross_amount": "0.00",
        "retried_payouts_fee_amount": "0.00",
        "retried_payouts_gross_amount": "0.00"
      }
    },
    {
      "id": 917000993,
      "status": "failed",
      "date": "2012-11-13",
      "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"
      }
    },
    {
      "id": 867808544,
      "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"
      }
    },
    {
      "id": 725076685,
      "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"
      }
    },
    {
      "id": 714327683,
      "status": "failed",
      "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"
      }
    },
    {
      "id": 631321250,
      "status": "scheduled",
      "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"
      }
    },
    {
      "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"
      }
    }
  ]
}
Anchor to section titled 'GET request, Return a single payout'

get
Return a single payout

shopifyPaymentsAccount
Retrieves a single payout by id.
Anchor to section titled 'Parameters of Return a single payout'

Parameters

api_version
string
required
payout_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Return a single payout'

Examples

Path parameters
payoutid=623721858
string
required
Was this section helpful?
get
/admin/api/2024-10/shopify_payments/payouts/623721858.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/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"
    }
  }
}