PayPal-PHP-Server-SDK/doc/models/stored-payment-source.md

Stored Payment Source

Provides additional details to process a payment using a payment_source that has been stored or is intended to be stored (also referred to as stored_credential or card-on-file). Parameter compatibility: payment_type=ONE_TIME is compatible only with payment_initiator=CUSTOMER. usage=FIRST is compatible only with payment_initiator=CUSTOMER. previous_transaction_reference or previous_network_transaction_reference is compatible only with payment_initiator=MERCHANT. Only one of the parameters - previous_transaction_reference and previous_network_transaction_reference - can be present in the request.

Structure

StoredPaymentSource

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
paymentType	string(StoredPaymentSourcePaymentType)	Required	Indicates the type of the stored payment_source payment. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$	getPaymentType(): string	setPaymentType(string paymentType): 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
previousNetworkTransactionReference	?NetworkTransaction	Optional	Reference values used by the card network to identify a transaction.	getPreviousNetworkTransactionReference(): ?NetworkTransaction	setPreviousNetworkTransactionReference(?NetworkTransaction previousNetworkTransactionReference): void

Example (as JSON)

{
  "payment_initiator": "CUSTOMER",
  "payment_type": "RECURRING",
  "usage": "DERIVED",
  "previous_network_transaction_reference": {
    "id": "id6",
    "date": "date2",
    "network": "CONFIDIS",
    "acquirer_reference_number": "acquirer_reference_number8"
  }
}