Balances Response

balancesobject<balance_detail>[]Optional

An array of balance detail objects.

Items1 <= length <= 200

balance_detail properties

5 properties

total_balanceobject<money-2>Required

The total amount in PayPal account. It is the sum of all the other balances.

available_balanceobject<money-2>Optional

The amount of cash in an Account which is at the customer's disposal. This amount is captured at settlement cutoff time in the user's time zone as defined for the user.

withheld_balanceobject<money-2>Optional

Balance withheld in the account. The portion of funds that PayPal holds for the customer that is not currently at the customer's disposal.

account_idstring<account_id>Optional

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.

Match^[2-9A-HJ-NP-Z]{13}$Formatppaas_payer_id_v3Length13 <= length <= 13

as_of_timestring<date_time>Optional

The requested date and time or the last date and time when the balances can be served, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

last_refresh_timestring<date_time>Optional

The date and time when the balances was last refreshed, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

balance_detail properties

money-2 properties

money-2 properties

money-2 properties

Back to top

On this page

On this page

Balances Response

balance_detail properties

money-2 properties

money-2 properties

money-2 properties

Back to top

On this page

Balances Response

balance_detail properties

money-2 properties

money-2 properties

money-2 properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Balances Response

balance_detail properties

money-2 properties

money-2 properties

money-2 properties

Back to top

On this page