PayPal-PHP-Server-SDK/doc/models/paypal-wallet-stored-credential.md

Paypal Wallet Stored Credential

Provides additional details to process a payment using the PayPal wallet billing agreement or a vaulted payment method that has been stored or is intended to be stored.

Structure

PaypalWalletStoredCredential

Fields

Name	Type	Tags	Description	Getter	Setter
paymentInitiator	string(PaymentInitiator)	Required	The person or party who initiated or triggered the payment. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getPaymentInitiator(): string	setPaymentInitiator(string paymentInitiator): void
chargePattern	?string(UsagePattern)	Optional	Expected business/pricing model for the billing agreement. Constraints: Minimum Length: 1, Maximum Length: 30, Pattern: ^[A-Z0-9_]+$	getChargePattern(): ?string	setChargePattern(?string chargePattern): void
usagePattern	?string(UsagePattern)	Optional	Expected business/pricing model for the billing agreement. Constraints: Minimum Length: 1, Maximum Length: 30, Pattern: ^[A-Z0-9_]+$	getUsagePattern(): ?string	setUsagePattern(?string usagePattern): void
usage	?string(StoredPaymentSourceUsageType)	Optional	Indicates if this is a first or subsequent payment using a stored payment source (also referred to as stored credential or card on file). Default: StoredPaymentSourceUsageType::DERIVED Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getUsage(): ?string	setUsage(?string usage): void

Example (as JSON)

{
  "payment_initiator": "CUSTOMER",
  "usage": "DERIVED",
  "charge_pattern": "IMMEDIATE",
  "usage_pattern": "IMMEDIATE"
}