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 RefundRequest

Class RefundRequest

A refund transaction.

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

Methods summary

public
# setAmount( PayPal\Api\Amount $amount )

Details including both refunded amount (to payer) and refunded fee (to payee).

Details including both refunded amount (to payer) and refunded fee (to payee).

Parameters

$amount

Returns


$this
public PayPal\Api\Amount
# getAmount( )

Details including both refunded amount (to payer) and refunded fee (to payee).

Details including both refunded amount (to payer) and refunded fee (to payee).

Returns

PayPal\Api\Amount
public
# setDescription( string $description )

Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.

Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.

Parameters

$description

Returns


$this
public string
# getDescription( )

Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.

Description of what is being refunded for. Character length and limitations: 255 single-byte alphanumeric characters.

Returns

string
public
# setRefundSource( string $refund_source )

Type of PayPal funding source (balance or eCheck) that can be used for auto refund. Valid Values: ["INSTANT_FUNDING_SOURCE", "ECHECK", "UNRESTRICTED"]

Type of PayPal funding source (balance or eCheck) that can be used for auto refund. Valid Values: ["INSTANT_FUNDING_SOURCE", "ECHECK", "UNRESTRICTED"]

Parameters

$refund_source

Returns


$this
public string
# getRefundSource( )

Type of PayPal funding source (balance or eCheck) that can be used for auto refund.

Type of PayPal funding source (balance or eCheck) that can be used for auto refund.

Returns

string
public
# setReason( string $reason )

Reason description for the Sale transaction being refunded.

Reason description for the Sale transaction being refunded.

Parameters

$reason

Returns


$this
public string
# getReason( )

Reason description for the Sale transaction being refunded.

Reason description for the Sale transaction being refunded.

Returns

string
public
# setInvoiceNumber( string $invoice_number )

The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.

The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.

Parameters

$invoice_number

Returns


$this
public string
# getInvoiceNumber( )

The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.

The invoice number that is used to track this payment. Character length and limitations: 127 single-byte alphanumeric characters.

Returns

string
public
# setRefundAdvice( boolean $refund_advice )

Flag to indicate that the buyer was already given store credit for a given transaction.

Flag to indicate that the buyer was already given store credit for a given transaction.

Parameters

$refund_advice

Returns


$this
public boolean
# getRefundAdvice( )

Flag to indicate that the buyer was already given store credit for a given transaction.

Flag to indicate that the buyer was already given store credit for a given transaction.

Returns

boolean

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