Skip to main content
GET
/
v1
/
reporting
/
balances
List all balances
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/reporting/balances \
  --header 'Authorization: Bearer <token>'
{
  "balances": [
    {
      "currency": "<string>",
      "primary": true,
      "total_balance": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "available_balance": {
        "currency_code": "<string>",
        "value": "<string>"
      },
      "withheld_balance": {
        "currency_code": "<string>",
        "value": "<string>"
      }
    }
  ],
  "account_id": "<string>",
  "as_of_time": "<string>",
  "last_refresh_time": "<string>"
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Query Parameters

​
as_of_time
string

List balances in the response at the date time provided, will return the last refreshed balance in the system when not provided.

Required string length: 20 - 64
​
currency_code
string

Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.

Required string length: 3

Response

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

The balances response information.

​
balances
Balance Information · object[]

An array of balance detail objects.

Maximum length: 200
​
account_id
string<ppaas_payer_id_v3>

The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and a proprietary variant of Base32 is used to encode the result.

Required string length: 13
​
as_of_time
string<ppaas_date_time_v3>

The requested date and time or the last date and time when the balances can be served, in Internet date and time format.

Required string length: 20 - 64
​
last_refresh_time
string<ppaas_date_time_v3>

The date and time when the balances was last refreshed, in Internet date and time format.

Required string length: 20 - 64
⌘I