---
title: "List all balances"
method: GET
path: "/v1/reporting/balances"
tags: ["balances"]
---

# List all balances

`GET /v1/reporting/balances`

List all balances. Specify date time to list balances for that time that appear in the response.<blockquote><strong>Notes:</strong> <ul><li>It takes a maximum of three hours for balances to appear in the list balances call.</li><li>This call lists balances upto the previous three years.</li></ul></blockquote>

## Query parameters

- `as_of_time` string
- `currency_code` string

## Response `200`

A successful request returns the HTTP `200 OK` status code and a JSON response body that lists balances .

- BalancesResponse — The balances response information.
  - `balances` BalanceDetail[] — An array of balance detail objects.
    - `currency` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
    - `primary` boolean — Optional field representing if the currency is primary currency or not.
    - `total_balance` Money, required — The currency and amount for a financial transaction, such as a balance or payment due.
      - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
      - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
    - `available_balance` Money — The currency and amount for a financial transaction, such as a balance or payment due.
      - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
      - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
    - `withheld_balance` Money — The currency and amount for a financial transaction, such as a balance or payment due.
      - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
      - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
  - `account_id` string, ppaas_payer_id_v3 — The account identifier for a PayPal account.
  - `as_of_time` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>
  - `last_refresh_time` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

## Other responses

- `400` — The request is not well-formed, is syntactically incorrect, or violates schema.
- `403` — Authorization failed due to insufficient permissions.
- `500` — An internal server error occurred.
- `default` — The default response.

---

[API](https://skmtc.net/paypal/apis/payments.md) · [All operations](https://skmtc.net/paypal/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paypal/payments/revisions/672aceee1190/schema)