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 CurrencyConversion

Class CurrencyConversion

Object used to store the currency conversion rate.

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

Methods summary

public
# setConversionDate( string $conversion_date )

Date of validity for the conversion rate.

Date of validity for the conversion rate.

Parameters

$conversion_date

Returns


$this
public string
# getConversionDate( )

Date of validity for the conversion rate.

Date of validity for the conversion rate.

Returns

string
public
# setFromCurrency( string $from_currency )

3 letter currency code

3 letter currency code

Parameters

$from_currency

Returns


$this
public string
# getFromCurrency( )

3 letter currency code

3 letter currency code

Returns

string
public
# setFromAmount( string $from_amount )

Amount participating in currency conversion, set to 1 as default

Amount participating in currency conversion, set to 1 as default

Parameters

$from_amount

Returns


$this
public string
# getFromAmount( )

Amount participating in currency conversion, set to 1 as default

Amount participating in currency conversion, set to 1 as default

Returns

string
public
# setToCurrency( string $to_currency )

3 letter currency code

3 letter currency code

Parameters

$to_currency

Returns


$this
public string
# getToCurrency( )

3 letter currency code

3 letter currency code

Returns

string
public
# setToAmount( string $to_amount )

Amount resulting from currency conversion.

Amount resulting from currency conversion.

Parameters

$to_amount

Returns


$this
public string
# getToAmount( )

Amount resulting from currency conversion.

Amount resulting from currency conversion.

Returns

string
public
# setConversionType( string $conversion_type )

Field indicating conversion type applied. Valid Values: ["PAYPAL", "VENDOR"]

Field indicating conversion type applied. Valid Values: ["PAYPAL", "VENDOR"]

Parameters

$conversion_type

Returns


$this
public string
# getConversionType( )

Field indicating conversion type applied.

Field indicating conversion type applied.

Returns

string
public
# setConversionTypeChangeable( boolean $conversion_type_changeable )

Allow Payer to change conversion type.

Allow Payer to change conversion type.

Parameters

$conversion_type_changeable

Returns


$this
public boolean
# getConversionTypeChangeable( )

Allow Payer to change conversion type.

Allow Payer to change conversion type.

Returns

boolean
public
# setWebUrl( string $web_url )

Base URL to web applications endpoint Valid Values: ["https://www.paypal.com/{country_code}/webapps/xocspartaweb/webflow/sparta/proxwebflow", "https://www.paypal.com/{country_code}/proxflow"]

Base URL to web applications endpoint Valid Values: ["https://www.paypal.com/{country_code}/webapps/xocspartaweb/webflow/sparta/proxwebflow", "https://www.paypal.com/{country_code}/proxflow"]

Deprecated

Not publicly available

Parameters

$web_url

Returns


$this

Throws

InvalidArgumentException
public string
# getWebUrl( )

Base URL to web applications endpoint

Base URL to web applications endpoint

Deprecated

Not publicly available

Returns

string
public
# setLinks( PayPal\Api\Links[] $links )

Sets Links

Sets Links

Parameters

$links

Returns


$this
public PayPal\Api\Links[]
# getLinks( )

Gets Links

Gets Links

Returns

PayPal\Api\Links[]
public
# addLink( PayPal\Api\Links $links )

Append Links to the list.

Append Links to the list.

Parameters

$links

Returns


$this
public
# removeLink( PayPal\Api\Links $links )

Remove Links from the list.

Remove Links from the list.

Parameters

$links

Returns


$this

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