Overview
  • Namespace
  • Class

Namespaces

  • PayPal
    • Api
    • Auth
    • Cache
    • Common
    • Converter
    • Core
    • Exception
    • Handler
    • Log
    • Rest
    • Security
    • Transport
    • Validation

Classes

  • Address
  • Agreement
  • AgreementDetails
  • AgreementStateDescriptor
  • AgreementTransaction
  • AgreementTransactions
  • AlternatePayment
  • Amount
  • Authorization
  • BankAccount
  • BankAccountsList
  • BankToken
  • BaseAddress
  • Billing
  • BillingAgreementToken
  • BillingInfo
  • CancelNotification
  • Capture
  • CarrierAccount
  • CarrierAccountToken
  • CartBase
  • ChargeModel
  • Cost
  • CountryCode
  • CreateProfileResponse
  • Credit
  • CreditCard
  • CreditCardHistory
  • CreditCardList
  • CreditCardToken
  • CreditFinancingOffered
  • Currency
  • CurrencyConversion
  • CustomAmount
  • DetailedRefund
  • Details
  • Error
  • ErrorDetails
  • ExtendedBankAccount
  • ExternalFunding
  • FileAttachment
  • FlowConfig
  • FmfDetails
  • FundingDetail
  • FundingInstrument
  • FundingOption
  • FundingSource
  • FuturePayment
  • HyperSchema
  • Image
  • Incentive
  • InputFields
  • InstallmentInfo
  • InstallmentOption
  • Invoice
  • InvoiceAddress
  • InvoiceItem
  • InvoiceNumber
  • InvoiceSearchResponse
  • Item
  • ItemList
  • Links
  • Measurement
  • MerchantInfo
  • MerchantPreferences
  • Metadata
  • NameValuePair
  • Notification
  • OpenIdAddress
  • OpenIdError
  • OpenIdSession
  • OpenIdTokeninfo
  • OpenIdUserinfo
  • Order
  • OverrideChargeModel
  • Participant
  • Patch
  • PatchRequest
  • Payee
  • Payer
  • PayerInfo
  • Payment
  • PaymentCard
  • PaymentCardToken
  • PaymentDefinition
  • PaymentDetail
  • PaymentExecution
  • PaymentHistory
  • PaymentInstruction
  • PaymentOptions
  • PaymentSummary
  • PaymentTerm
  • Payout
  • PayoutBatch
  • PayoutBatchHeader
  • PayoutItem
  • PayoutItemDetails
  • PayoutSenderBatchHeader
  • Phone
  • Plan
  • PlanList
  • PotentialPayerInfo
  • Presentation
  • PrivateLabelCard
  • ProcessorResponse
  • RecipientBankingInstruction
  • RedirectUrls
  • Refund
  • RefundDetail
  • RefundRequest
  • RelatedResources
  • Sale
  • Search
  • ShippingAddress
  • ShippingCost
  • ShippingInfo
  • Tax
  • Template
  • TemplateData
  • Templates
  • TemplateSettings
  • TemplateSettingsMetadata
  • Terms
  • Transaction
  • TransactionBase
  • Transactions
  • VerifyWebhookSignature
  • VerifyWebhookSignatureResponse
  • Webhook
  • WebhookEvent
  • WebhookEventList
  • WebhookEventType
  • WebhookEventTypeList
  • WebhookList
  • WebProfile

Class FlowConfig

Class FlowConfig

Parameters for flow configuration.

PayPal\Common\PayPalModel
Extended by PayPal\Api\FlowConfig
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/FlowConfig.php

Methods summary

public
# setLandingPageType( string $landing_page_type )

The type of landing page to display on the PayPal site for user checkout. Set to Billing to use the non-PayPal account landing page. Set to Login to use the PayPal account login landing page.

The type of landing page to display on the PayPal site for user checkout. Set to Billing to use the non-PayPal account landing page. Set to Login to use the PayPal account login landing page.

Parameters

$landing_page_type

Returns


$this
public string
# getLandingPageType( )

The type of landing page to display on the PayPal site for user checkout. Set to Billing to use the non-PayPal account landing page. Set to Login to use the PayPal account login landing page.

The type of landing page to display on the PayPal site for user checkout. Set to Billing to use the non-PayPal account landing page. Set to Login to use the PayPal account login landing page.

Returns

string
public
# setBankTxnPendingUrl( string $bank_txn_pending_url )

The merchant site URL to display after a bank transfer payment. Valid for only the Giropay or bank transfer payment method in Germany.

The merchant site URL to display after a bank transfer payment. Valid for only the Giropay or bank transfer payment method in Germany.

Parameters

$bank_txn_pending_url

Returns


$this

Throws

InvalidArgumentException
public string
# getBankTxnPendingUrl( )

The merchant site URL to display after a bank transfer payment. Valid for only the Giropay or bank transfer payment method in Germany.

The merchant site URL to display after a bank transfer payment. Valid for only the Giropay or bank transfer payment method in Germany.

Returns

string
public
# setUserAction( string $user_action )

Defines whether buyers can complete purchases on the PayPal or merchant website.

Defines whether buyers can complete purchases on the PayPal or merchant website.

Parameters

$user_action

Returns


$this
public string
# getUserAction( )

Defines whether buyers can complete purchases on the PayPal or merchant website.

Defines whether buyers can complete purchases on the PayPal or merchant website.

Returns

string
public
# setReturnUriHttpMethod( string $return_uri_http_method )

Defines the HTTP method to use to redirect the user to a return URL. A valid value is GET or POST.

Defines the HTTP method to use to redirect the user to a return URL. A valid value is GET or POST.

Parameters

$return_uri_http_method

Returns


$this
public string
# getReturnUriHttpMethod( )

Defines the HTTP method to use to redirect the user to a return URL. A valid value is GET or POST.

Defines the HTTP method to use to redirect the user to a return URL. A valid value is GET or POST.

Returns

string

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

API documentation generated by ApiGen