View as Markdown
API Spec (JSON)
API Spec (YAML)
Compact modeHides field descriptions and other prose for a more compact, scannable view of the API reference.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.
Client CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheaderScopes
https://uri.paypal.com/services/reporting/balances/readas_of_timestringOptionalPayPal-Enforce-ISO8601-FormatbooleanOptionalPayPal-Enforce-ISO8601-Formatin the header. When this value is set to true, the APIs will support the new date time format and platform changes.
Note: You can use the same header in the sandbox as well.
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/reporting/balances"{ "balances": [ { "currency": "str", "primary": true, "total_balance": { "currency_code": "str", "value": "string" }, "available_balance": { "currency_code": "str", "value": "string" }, "withheld_balance": { "currency_code": "str", "value": "string" } } ], "account_id": "stringstrings", "as_of_time": "stringstringstringst", "last_refresh_time": "stringstringstringst"}