List all balances - Paypal API

List all balances. Specify date time to list balances for that time that appear in the response.

Notes:
It takes a maximum of three hours for balances to appear in the list balances call.
This call lists balances upto the previous three years.

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Query 参数

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.

示例值:

2022-03-20T00:00:00.000Z

currency_code

string

必需

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

示例值:

ALL

include_crypto_currencies

string

必需

Indicates whether the response list balances including crypto transactions. Value is either:

false. The default. The response doesn't include crypto transactions.
true. The response also includes crypto transactions.

示例值:

true

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200200 - List Balances For All Currencies

application/json

Body

balances

array [object {5}]

必需

currency

string

必需

total_balance

object

必需

available_balance

object

必需

withheld_balance

object

必需

primary

boolean

可选

account_id

string

必需

as_of_time

string

必需

last_refresh_time

string

必需

示例

{
    "balances": [
        {
            "currency": "EUR",
            "total_balance": {
                "currency_code": "EUR",
                "value": "258.83"
            },
            "available_balance": {
                "currency_code": "EUR",
                "value": "258.83"
            },
            "withheld_balance": {
                "currency_code": "EUR",
                "value": "0.00"
            }
        },
        {
            "currency": "GBP",
            "total_balance": {
                "currency_code": "GBP",
                "value": "0.00"
            },
            "available_balance": {
                "currency_code": "GBP",
                "value": "0.00"
            },
            "withheld_balance": {
                "currency_code": "GBP",
                "value": "0.00"
            }
        },
        {
            "currency": "USD",
            "primary": true,
            "total_balance": {
                "currency_code": "USD",
                "value": "1542775.33"
            },
            "available_balance": {
                "currency_code": "USD",
                "value": "1542717.74"
            },
            "withheld_balance": {
                "currency_code": "USD",
                "value": "57.59"
            }
        },
        {
            "currency": "CAD",
            "total_balance": {
                "currency_code": "CAD",
                "value": "128951.92"
            },
            "available_balance": {
                "currency_code": "CAD",
                "value": "128951.92"
            },
            "withheld_balance": {
                "currency_code": "CAD",
                "value": "0.00"
            }
        }
    ],
    "account_id": "ER87FV8ER63HJ",
    "as_of_time": "2022-02-24T17:59:59Z",
    "last_refresh_time": "2022-02-24T17:59:59Z"
}

🟢200200 - List Balances For USD Only

🟢200200 - List Balances With Minimal Request

🟠400400 Bad Request - Invalid Currency Code

🟠401401 Unauthorized - Invalid Token