On this page
No Headings
The balances response information.
objectbalancesarrayAn array of balance detail objects.
itemsobjectThe Balance information.
currencyrequiredstringppaas_common_currency_code_v2Currency Code of the balances listed.
primarybooleanOptional field representing if the currency is primary currency or not.
total_balancerequiredobjectThe total amount in PayPal account. It is the sum of all the other balances.
currency_coderequiredstringppaas_common_currency_code_v2The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.available_balanceobjectThe 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.
currency_coderequiredstringppaas_common_currency_code_v2The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.withheld_balanceobjectBalance withheld in the account. The portion of funds that PayPal holds for the customer that is not currently at the customer's disposal.
currency_coderequiredstringppaas_common_currency_code_v2The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.account_idstringppaas_payer_id_v3^[2-9A-HJ-NP-Z]{13}$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.
as_of_timestringppaas_date_time_v3^[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})$The requested date and time or the last date and time when the balances can be served, in Internet date and time format.
last_refresh_timestringppaas_date_time_v3^[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})$The date and time when the balances was last refreshed, in Internet date and time format.