On this page
No Headings
GetBalance API Operation (SOAP)
Last updated: June 12, 2026
API
Important: NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, we recommend our latest solutions.
Shows the available balance for a PayPal account.
GetBalance Request Message
Note: Only the fields described in this documentation are available for use.
GetBalance Request Fields
| Field | Description |
|---|---|
ReturnAllCurrencies | xs:string(Optional) Indicates whether to return all currencies. Value is:
Note: This field is available since version 51. Prior versions return only the balance for the primary currency holding. |
GetBalance Response Message
Note: Only the fields described in this documentation are available for use.
GetBalance Response Fields
| Field | Description |
|---|---|
Balance | ebl:BasicAmountTypeAvailable balance and associated currency code for the primary currency holding. |
BalanceTimeStamp | xs:dateTimeTime that the balance was reported. |
BalanceHoldings | ebl:BasicAmountTypeAvailable balance and associated currency code for each currency held, including the primary currency. The first currency is the primary currency. |