Wallet

external_customer_idstringRequired

External system reference to the customer

statusenum<WalletStatus>Required

Current status of the wallet

Value in"ACTIVE" | "TERMINATED" | "PENDING"

available_balanceobject<Amount>Optional

ongoing_usageobject<Amount>Optional

The ongoing usage of the wallet, and it reflects all current usage and draft invoices including taxes.

net_balanceobject<Amount>Optional

This represents the real-time balance after accounting for current usage,.

namestringOptional

Human-readable wallet name

rate_amountstringRequired

Price charged per credit unit

available_creditsstringOptional

Current credit balance available

ongoing_usage_creditsstringOptional

This reflects all current usage and draft invoices.

net_balance_creditsstringOptional

This represents the real time balance after accounting for current usage.

consumed_creditsstringOptional

Total credits consumed so far

created_atstring<DateTimeWithZone>Optional

Date and time when the wallet was created, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Formatdate-time

expiration_atstring<DateTimeWithZone>Optional

Date and time when the wallet is set to expire, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Formatdate-time

terminated_atstring<DateTimeWithZone>Optional

Date and time when the wallet was terminated, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).

Formatdate-time

applies_toobject<PrepaidCreditAppliesTo>Optional

Indicates whether the prepaid credit applies to the entire invoice or only to specific line items.

recurring_transaction_rulesobject<RecurringTransactionRule>[]Optional

List of recurring transaction rules for automatic top-ups

Amount properties

Amount properties

Amount properties

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page

On this page

Wallet

Amount properties

Amount properties

Amount properties

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page

Wallet

Amount properties

Amount properties

Amount properties

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Wallet

Amount properties

Amount properties

Amount properties

PrepaidCreditAppliesTo properties

RecurringTransactionRule properties

Back to top

On this page