List all balances
GET {{base_url}}/v1/reporting/balances?as_of_time=2022-03-20T00:00:00.000Z¤cy_code=ALL&include_crypto_currencies=true
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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. | |
currency_code | string | Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency. | |
include_crypto_currencies | boolean | Indicates whether the response list balances including crypto transactions. Value is either:<ul><li><code>false</code>. The default. The response doesn't include crypto transactions.</li><li><code>true</code>. The response also includes crypto transactions.</li></ul> |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json. | |
PayPal-Request-Id | string | The server stores keys for 72 hours. | |
PayPal-Client-Metadata-Id | string | Optional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection. | |
PayPal-Partner-Attribution-Id | string | Optional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference. | |
PayPal-Auth-Assertion | string | An API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant. | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> | |
Prefer | string | The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul> |
RESPONSES
status: OK
{"balances":[{"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"}}],"account_id":"ER87FV8ER63HJ","as_of_time":"2022-02-24T17:59:59Z","last_refresh_time":"2022-02-24T17:59:59Z"}