Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
balances

List all 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>

get/v1/reporting/balances

Query parameters

as_of_timestring

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

currency_codestring

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

Response

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

account_idstring ppaas_payer_id_v3

The account identifier for a PayPal account.

as_of_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. 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_timestring ppaas_date_time_v3

The date and time, in Internet date and time format. 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>