--- title: Payouts description: Get information regarding Shopify Payments payouts. api_version: 2025-10 api_name: admin-rest api_type: rest source_url: html: https://shopify.dev/docs/api/admin-rest/latest/resources/payouts md: https://shopify.dev/docs/api/admin-rest/latest/resources/payouts.md --- ![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg) 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](https://shopify.dev/docs/api/admin-graphql). For details and migration steps, visit our [migration guide](https://shopify.dev/docs/apps/build/graphql/migrate). # 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. \# ## Endpoints * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/payouts#get-shopify-payments-payouts) [/admin/api/latest/shopify\_​payments/payouts.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/payouts#get-shopify-payments-payouts) Return a list of all payouts [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-list-of-all-payouts) [shopifyPaymentsAccount](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-list-of-all-payouts) * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/payouts#get-shopify-payments-payouts-payout-id) [/admin/api/latest/shopify\_​payments/payouts/{payout\_​id}.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/payouts#get-shopify-payments-payouts-payout-id) Return a single payout [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-single-payout) [shopifyPaymentsAccount](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-single-payout) *** ## The Payouts resource ### Properties *** id -> [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.id) [id](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.id) The unique identifier of the payout *** status -> [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.status) [status](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.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 -> [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.issuedAt) [issuedAt](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout#field-ShopifyPaymentsPayout.fields.issuedAt) The date ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the payout was issued. *** currency -> [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2#field-MoneyV2.fields.currencyCode) [currencyCode](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2#field-MoneyV2.fields.currencyCode) The ISO 4217 currency code of the payout. *** amount -> [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2#field-MoneyV2.fields.amount) [amount](https://shopify.dev/docs/api/admin-graphql/latest/objects/MoneyV2#field-MoneyV2.fields.amount) The total amount of the payout, in a decimal formatted string. *** {} ## The Payouts resource ```json { "id": 54534554564, "status": "scheduled", "date": "2018-03-22", "currency": "USD", "amount": "102.53" } ``` *** ## getReturn a list of all payouts [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-list-of-all-payouts) [shopifyPaymentsAccount](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-list-of-all-payouts) 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](https://shopify.dev/api/usage/pagination-rest). ### 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. *** ### Examples 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. get ## /admin/api/2025-10/shopify\_​payments/payouts.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shopify_payments/payouts.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```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", ``` ### examples * #### List all payouts ordered newest to oldest ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shopify_payments/payouts.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` ##### ```remix await admin.rest.resources.Payout.all({ session: session, }); ``` ##### ```ruby # Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Payout.all( session: test_session, ) ``` ##### ```node // Session is built by the OAuth process await shopify.rest.Payout.all({ session: session, }); ``` #### 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"}}]} ``` * #### List all payouts up to a specified date ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shopify_payments/payouts.json?date_max=2012-11-12" \ -H "X-Shopify-Access-Token: {access_token}" ``` ##### ```remix await admin.rest.resources.Payout.all({ session: session, date_max: "2012-11-12", }); ``` ##### ```ruby # Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Payout.all( session: test_session, date_max: "2012-11-12", ) ``` ##### ```node // Session is built by the OAuth process await shopify.rest.Payout.all({ session: session, date_max: "2012-11-12", }); ``` #### response ```json HTTP/1.1 200 OK{"payouts":[{"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"}}]} ``` *** ## getReturn a single payout [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-single-payout) [shopifyPaymentsAccount](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-a-single-payout) Retrieves a single payout by id. ### Parameters *** api\_version string required *** payout\_id string required *** ### Examples Retrieves a single payout by id Path parameters payout\_​id=​623721858 string required get ## /admin/api/2025-10/shopify\_​payments/payouts/623721858.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shopify_payments/payouts/623721858.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```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" } } } ``` ### examples * #### Retrieves a single payout by id ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shopify_payments/payouts/623721858.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` ##### ```remix await admin.rest.resources.Payout.find({ session: session, id: 623721858, }); ``` ##### ```ruby # Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Payout.find( session: test_session, id: 623721858, ) ``` ##### ```node // Session is built by the OAuth process await shopify.rest.Payout.find({ session: session, id: 623721858, }); ``` #### 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"}}} ```