GetBalance API Operation (NVP)

API

Last updated: Aug 15th, 7:01am

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

GetBalance Request Fields

Field	Description
`METHOD`	(Required) Must be `GetBalance`.
`RETURNALLCURRENCIES`	(Optional) Indicates whether to return all currencies. Value is: `0` — Return only the balance for the primary currency holding. `1` — Return the balance for each currency holding. Note: This field is available since `version` `51`. Prior versions return only the balance for the primary currency holding.

Field

Description

METHOD

(Required) Must be GetBalance.

RETURNALLCURRENCIES

(Optional) Indicates whether to return all currencies. Value is:

0 — Return only the balance for the primary currency holding.
1 — Return the balance for each currency holding.

Note: This field is available since version 51. Prior versions return only the balance for the primary currency holding.

GetBalance Response Message

GetBalance Response Fields

Field	Description
`L_AMTn`	Available balance and associated currency code for the primary currency holding.
`L_CURRENCYCODEn`	Currency code, such as USD, associated with the holding.