API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

Payouts

Version 2020-01
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 
"id": 54534554564

The unique identifier of the payout
status 
"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 
"date": "2018-03-22"

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

currency 
"currency": "USD"

The ISO 4217 currency code of the payout.
amount 
"amount": "102.53"

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

Endpoints

GET /admin/api/2020-01/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.
since_id

Filter the response to payouts made after the specified ID.
last_id

Filter the response to payouts made before the specified ID.
date_min

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

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

Filter the response to payouts made on the specified date.
status

Filter the response to payouts made with the specified status.

List all payouts ordered newest to oldest

GET /admin/api/2020-01/shopify_payments/payouts.json
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "id": 854088011,
      "status": "scheduled",
      "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": 512467833,
      "status": "failed",
      "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": 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": 710174591,
      "status": "paid",
      "date": "2012-12-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": 974708905,
      "status": "paid",
      "date": "2012-11-13",
      "currency": "CAD",
      "amount": "51.69",
      "summary": {
        "adjustments_fee_amount": "0.12",
        "adjustments_gross_amount": "2.13",
        "charges_fee_amount": "6.46",
        "charges_gross_amount": "58.15",
        "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"
      }
    }
  ]
}

List all payouts up to a specified date

GET /admin/api/2020-01/shopify_payments/payouts.json?date_max=2012-11-12
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "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"
      }
    }
  ]
}
GET /admin/api/2020-01/shopify_payments/payouts/{payout_id}.json
Retrieves a single payout by id.

Retrieves a single payout by id

GET /admin/api/2020-01/shopify_payments/payouts/623721858.json
View Response 
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"
    }
  }
}
Version 2020-04
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 
"id": 54534554564

The unique identifier of the payout
status 
"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 
"date": "2018-03-22"

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

currency 
"currency": "USD"

The ISO 4217 currency code of the payout.
amount 
"amount": "102.53"

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

Endpoints

GET /admin/api/2020-04/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.
since_id

Filter the response to payouts made after the specified ID.
last_id

Filter the response to payouts made before the specified ID.
date_min

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

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

Filter the response to payouts made on the specified date.
status

Filter the response to payouts made with the specified status.

List all payouts ordered newest to oldest

GET /admin/api/2020-04/shopify_payments/payouts.json
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "id": 854088011,
      "status": "scheduled",
      "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": 512467833,
      "status": "failed",
      "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": 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": 710174591,
      "status": "paid",
      "date": "2012-12-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": 974708905,
      "status": "paid",
      "date": "2012-11-13",
      "currency": "CAD",
      "amount": "51.69",
      "summary": {
        "adjustments_fee_amount": "0.12",
        "adjustments_gross_amount": "2.13",
        "charges_fee_amount": "6.46",
        "charges_gross_amount": "58.15",
        "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"
      }
    }
  ]
}

List all payouts up to a specified date

GET /admin/api/2020-04/shopify_payments/payouts.json?date_max=2012-11-12
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "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"
      }
    }
  ]
}
GET /admin/api/2020-04/shopify_payments/payouts/{payout_id}.json
Retrieves a single payout by id.

Retrieves a single payout by id

GET /admin/api/2020-04/shopify_payments/payouts/623721858.json
View Response 
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"
    }
  }
}
Version 2020-07
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 
"id": 54534554564

The unique identifier of the payout
status 
"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 
"date": "2018-03-22"

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

currency 
"currency": "USD"

The ISO 4217 currency code of the payout.
amount 
"amount": "102.53"

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

Endpoints

GET /admin/api/2020-07/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.
since_id

Filter the response to payouts made after the specified ID.
last_id

Filter the response to payouts made before the specified ID.
date_min

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

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

Filter the response to payouts made on the specified date.
status

Filter the response to payouts made with the specified status.

List all payouts ordered newest to oldest

GET /admin/api/2020-07/shopify_payments/payouts.json
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "id": 854088011,
      "status": "scheduled",
      "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": 512467833,
      "status": "failed",
      "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": 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": 710174591,
      "status": "paid",
      "date": "2012-12-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": 974708905,
      "status": "paid",
      "date": "2012-11-13",
      "currency": "CAD",
      "amount": "51.69",
      "summary": {
        "adjustments_fee_amount": "0.12",
        "adjustments_gross_amount": "2.13",
        "charges_fee_amount": "6.46",
        "charges_gross_amount": "58.15",
        "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"
      }
    }
  ]
}

List all payouts up to a specified date

GET /admin/api/2020-07/shopify_payments/payouts.json?date_max=2012-11-12
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "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"
      }
    }
  ]
}
GET /admin/api/2020-07/shopify_payments/payouts/{payout_id}.json
Retrieves a single payout by id.

Retrieves a single payout by id

GET /admin/api/2020-07/shopify_payments/payouts/623721858.json
View Response 
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"
    }
  }
}
Version 2020-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 
"id": 54534554564

The unique identifier of the payout
status 
"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 
"date": "2018-03-22"

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

currency 
"currency": "USD"

The ISO 4217 currency code of the payout.
amount 
"amount": "102.53"

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

Endpoints

GET /admin/api/2020-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.
since_id

Filter the response to payouts made after the specified ID.
last_id

Filter the response to payouts made before the specified ID.
date_min

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

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

Filter the response to payouts made on the specified date.
status

Filter the response to payouts made with the specified status.

List all payouts ordered newest to oldest

GET /admin/api/2020-10/shopify_payments/payouts.json
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "id": 854088011,
      "status": "scheduled",
      "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": 512467833,
      "status": "failed",
      "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": 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": 710174591,
      "status": "paid",
      "date": "2012-12-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": 974708905,
      "status": "paid",
      "date": "2012-11-13",
      "currency": "CAD",
      "amount": "51.69",
      "summary": {
        "adjustments_fee_amount": "0.12",
        "adjustments_gross_amount": "2.13",
        "charges_fee_amount": "6.46",
        "charges_gross_amount": "58.15",
        "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"
      }
    }
  ]
}

List all payouts up to a specified date

GET /admin/api/2020-10/shopify_payments/payouts.json?date_max=2012-11-12
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "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"
      }
    }
  ]
}
GET /admin/api/2020-10/shopify_payments/payouts/{payout_id}.json
Retrieves a single payout by id.

Retrieves a single payout by id

GET /admin/api/2020-10/shopify_payments/payouts/623721858.json
View Response 
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"
    }
  }
}
Version 2021-01 (Latest)
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 
"id": 54534554564

The unique identifier of the payout
status 
"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 
"date": "2018-03-22"

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

currency 
"currency": "USD"

The ISO 4217 currency code of the payout.
amount 
"amount": "102.53"

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

Endpoints

GET /admin/api/2021-01/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.
since_id

Filter the response to payouts made after the specified ID.
last_id

Filter the response to payouts made before the specified ID.
date_min

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

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

Filter the response to payouts made on the specified date.
status

Filter the response to payouts made with the specified status.

List all payouts ordered newest to oldest

GET /admin/api/2021-01/shopify_payments/payouts.json
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "id": 854088011,
      "status": "scheduled",
      "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": 512467833,
      "status": "failed",
      "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": 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": 710174591,
      "status": "paid",
      "date": "2012-12-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": 974708905,
      "status": "paid",
      "date": "2012-11-13",
      "currency": "CAD",
      "amount": "51.69",
      "summary": {
        "adjustments_fee_amount": "0.12",
        "adjustments_gross_amount": "2.13",
        "charges_fee_amount": "6.46",
        "charges_gross_amount": "58.15",
        "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"
      }
    }
  ]
}

List all payouts up to a specified date

GET /admin/api/2021-01/shopify_payments/payouts.json?date_max=2012-11-12
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "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"
      }
    }
  ]
}
GET /admin/api/2021-01/shopify_payments/payouts/{payout_id}.json
Retrieves a single payout by id.

Retrieves a single payout by id

GET /admin/api/2021-01/shopify_payments/payouts/623721858.json
View Response 
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"
    }
  }
}
Version 2021-04 (Release candidate)
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 
"id": 54534554564

The unique identifier of the payout
status 
"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 
"date": "2018-03-22"

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

currency 
"currency": "USD"

The ISO 4217 currency code of the payout.
amount 
"amount": "102.53"

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

Endpoints

GET /admin/api/2021-04/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.
since_id

Filter the response to payouts made after the specified ID.
last_id

Filter the response to payouts made before the specified ID.
date_min

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

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

Filter the response to payouts made on the specified date.
status

Filter the response to payouts made with the specified status.

List all payouts ordered newest to oldest

GET /admin/api/2021-04/shopify_payments/payouts.json
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "id": 854088011,
      "status": "scheduled",
      "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": 512467833,
      "status": "failed",
      "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": 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": 710174591,
      "status": "paid",
      "date": "2012-12-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": 974708905,
      "status": "paid",
      "date": "2012-11-13",
      "currency": "CAD",
      "amount": "51.69",
      "summary": {
        "adjustments_fee_amount": "0.12",
        "adjustments_gross_amount": "2.13",
        "charges_fee_amount": "6.46",
        "charges_gross_amount": "58.15",
        "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"
      }
    }
  ]
}

List all payouts up to a specified date

GET /admin/api/2021-04/shopify_payments/payouts.json?date_max=2012-11-12
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "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"
      }
    }
  ]
}
GET /admin/api/2021-04/shopify_payments/payouts/{payout_id}.json
Retrieves a single payout by id.

Retrieves a single payout by id

GET /admin/api/2021-04/shopify_payments/payouts/623721858.json
View Response 
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"
    }
  }
}
Version unstable
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 
"id": 54534554564

The unique identifier of the payout
status 
"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 
"date": "2018-03-22"

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

currency 
"currency": "USD"

The ISO 4217 currency code of the payout.
amount 
"amount": "102.53"

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

Endpoints

GET /admin/api/unstable/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.
since_id

Filter the response to payouts made after the specified ID.
last_id

Filter the response to payouts made before the specified ID.
date_min

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

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

Filter the response to payouts made on the specified date.
status

Filter the response to payouts made with the specified status.

List all payouts ordered newest to oldest

GET /admin/api/unstable/shopify_payments/payouts.json
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "id": 854088011,
      "status": "scheduled",
      "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": 512467833,
      "status": "failed",
      "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": 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": 710174591,
      "status": "paid",
      "date": "2012-12-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": 974708905,
      "status": "paid",
      "date": "2012-11-13",
      "currency": "CAD",
      "amount": "51.69",
      "summary": {
        "adjustments_fee_amount": "0.12",
        "adjustments_gross_amount": "2.13",
        "charges_fee_amount": "6.46",
        "charges_gross_amount": "58.15",
        "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"
      }
    }
  ]
}

List all payouts up to a specified date

GET /admin/api/unstable/shopify_payments/payouts.json?date_max=2012-11-12
View Response 
HTTP/1.1 200 OK
{
  "payouts": [
    {
      "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"
      }
    }
  ]
}
GET /admin/api/unstable/shopify_payments/payouts/{payout_id}.json
Retrieves a single payout by id.

Retrieves a single payout by id

GET /admin/api/unstable/shopify_payments/payouts/623721858.json
View Response 
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"
    }
  }
}