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 PaymentInstruction

Class PaymentInstruction

Contain details of how and when the payment should be made to PayPal in cases of manual bank transfer.

PayPal\Common\PayPalModel
Extended by PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource
Extended by PayPal\Api\PaymentInstruction
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/PaymentInstruction.php

Methods summary

public
# setReferenceNumber( string $reference_number )

ID of payment instruction

ID of payment instruction

Parameters

$reference_number

Returns


$this
public string
# getReferenceNumber( )

ID of payment instruction

ID of payment instruction

Returns

string
public
# setInstructionType( string $instruction_type )

Type of payment instruction Valid Values: ["MANUAL_BANK_TRANSFER", "PAY_UPON_INVOICE"]

Type of payment instruction Valid Values: ["MANUAL_BANK_TRANSFER", "PAY_UPON_INVOICE"]

Parameters

$instruction_type

Returns


$this
public string
# getInstructionType( )

Type of payment instruction

Type of payment instruction

Returns

string
public
# setRecipientBankingInstruction( PayPal\Api\RecipientBankingInstruction $recipient_banking_instruction )

Recipient bank Details.

Recipient bank Details.

Parameters

$recipient_banking_instruction

Returns


$this
public PayPal\Api\RecipientBankingInstruction
# getRecipientBankingInstruction( )

Recipient bank Details.

Recipient bank Details.

Returns

PayPal\Api\RecipientBankingInstruction
public
# setAmount( PayPal\Api\Currency $amount )

Amount to be transferred

Amount to be transferred

Parameters

$amount

Returns


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

Amount to be transferred

Amount to be transferred

Returns

PayPal\Api\Currency
public
# setPaymentDueDate( string $payment_due_date )

Date by which payment should be received

Date by which payment should be received

Parameters

$payment_due_date

Returns


$this
public string
# getPaymentDueDate( )

Date by which payment should be received

Date by which payment should be received

Returns

string
public
# setNote( string $note )

Additional text regarding payment handling

Additional text regarding payment handling

Parameters

$note

Returns


$this
public string
# getNote( )

Additional text regarding payment handling

Additional text regarding payment handling

Returns

string
public static PayPal\Api\PaymentInstruction
# get( string $paymentId, PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )

Retrieve a payment instruction by passing the payment_id in the request URI. Use this request if you are implementing a solution that includes delayed payment like Pay Upon Invoice (PUI).

Retrieve a payment instruction by passing the payment_id in the request URI. Use this request if you are implementing a solution that includes delayed payment like Pay Upon Invoice (PUI).

Parameters

$paymentId
$apiContext
is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall
is the Rest Call Service that is used to make rest calls

Returns

PayPal\Api\PaymentInstruction

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

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