GetBalance API Operation (SOAP)

API

Last updated: Aug 15th, 5:55am

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: `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

ReturnAllCurrencies

xs:string

(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

GetBalanceResponseType,Diagram

Note: Only the fields described in this documentation are available for use.

GetBalance Response Fields

Field	Description
`Balance`	`ebl:BasicAmountType` Available balance and associated currency code for the primary currency holding.
`BalanceTimeStamp`	`xs:dateTime` Time that the balance was reported.
`BalanceHoldings`	`ebl:BasicAmountType` Available balance and associated currency code for each currency held, including the primary currency. The first currency is the primary currency.

Field

Description

Balance

ebl:BasicAmountType

Available balance and associated currency code for the primary currency holding.

BalanceTimeStamp

xs:dateTime

Time that the balance was reported.

BalanceHoldings

ebl:BasicAmountType

Available balance and associated currency code for each currency held, including the primary currency. The first currency is the primary currency.