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.
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 not yet included in a Payout.
Was this section helpful?
#
Endpoints
- get/admin/api/latest/shopify_
payments/balance. json Return the current balance
Anchor to
The Balance resource
Anchor to
Properties
balance
->
balance
The account's current balance which contains the following properties:
Show balance properties
Show balance properties
-
amount: The balance amount. -
currency: Three letter currency code (ISO 4217 format).
Was this section helpful?
{}
The Balance resource
{
"balance": [
{
"amount": "22.56",
"currency": "USD"
}
]
}
Anchor to GET request, Return the current balancegetReturn the current balance
get
Return the current balance
Retrieves the account's current balance.
api_version
string
required
Was this section helpful?
Retrieves the account's current balance.
Retrieves the account's current balance.
Was this section helpful?
get
/admin/api/2025-07/shopify_
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/shopify_payments/balance.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"balance": [
{
"amount": "53.99",
"currency": "USD"
}
]
}