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'

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

The Balance resource

Properties
balance
->balance
The account's current balance which contains the following properties:
Was this section helpful?
{}The Balance resource
{
  "balance": [
    {
      "amount": "22.56",
      "currency": "USD"
    }
  ]
}
Anchor to section titled 'GET request, Return the current balance'

get
Return the current balance

shopifyPaymentsAccount
Retrieves the account's current balance.
Anchor to section titled 'Parameters of Return the current balance'

Parameters

api_version
string
required
Was this section helpful?
Anchor to section titled 'Examples of Return the current balance'

Examples

Was this section helpful?
get
/admin/api/2024-07/shopify_payments/balance.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-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"
    }
  ]
}