--- title: Balance description: View the current balance for a Shopify Payments account api_version: 2025-10 api_name: admin-rest api_type: rest source_url: html: https://shopify.dev/docs/api/admin-rest/latest/resources/balance md: https://shopify.dev/docs/api/admin-rest/latest/resources/balance.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). # Balance Requires ANY of the following access scopes: `shopify_payments_payouts`, `shopify_payments_accounts`. The account's current balance. This amount is comprised of any [Transaction](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/transaction) not yet included in a [Payout](https://shopify.dev/docs/admin-api/rest/reference/shopify_payments/payout). \# ## Endpoints * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/balance#get-shopify-payments-balance) [/admin/api/latest/shopify\_​payments/balance.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/balance#get-shopify-payments-balance) Return the current balance [![](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-the-current-balance) [shopifyPaymentsAccount](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-the-current-balance) *** ## The Balance resource ### Properties *** balance -> [![](https://shopify.dev/images/logos/GraphQL.svg)![](https://shopify.dev/images/logos/GraphQL-dark.svg)](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsAccount#field-ShopifyPaymentsAccount.fields.balance) [balance](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsAccount#field-ShopifyPaymentsAccount.fields.balance) The account's current balance which contains the following properties: Show balance properties * `amount`: The balance amount. * `currency`: Three letter currency code ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format). *** {} ## The Balance resource ```json { "balance": [ { "amount": "22.56", "currency": "USD" } ] } ``` *** ## getReturn the current balance [![](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-the-current-balance) [shopifyPaymentsAccount](https://shopify.dev/docs/api/admin-graphql/latest/queries/shopifyPaymentsAccount?example=return-the-current-balance) Retrieves the account's current balance. ### Parameters *** api\_version string required *** ### Examples Retrieves the account's current balance. get ## /admin/api/2025-10/shopify\_​payments/balance.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shopify_payments/balance.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```json HTTP/1.1 200 OK { "balance": [ { "amount": "53.99", "currency": "USD" } ] } ``` ### examples * #### Retrieves the account's current balance. ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/shopify_payments/balance.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` ##### ```remix await admin.rest.resources.Balance.all({ session: session, }); ``` ##### ```ruby # Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Balance.all( session: test_session, ) ``` ##### ```node // Session is built by the OAuth process await shopify.rest.Balance.all({ session: session, }); ``` #### response ```json HTTP/1.1 200 OK{"balance":[{"amount":"53.99","currency":"USD"}]} ```