PHP Class PayPal\EBLBaseComponents\PaymentInfoType

Inheritance: extends PayPal\Core\PPXmlMessage
Show file Open project: paypal/merchant-sdk-php

Public Properties

Property Type Description
$BinEligibility string This field indicates whether the credit card number used for this transaction is in a particular bin range registered with PayPal by the merchant. This filed is optional and will be present if merchant has a registered bin range. The value of this field will be "true" if merchant has a registered bin range and the credit card used in the transaction is within the registered bin range. The value of this field will be false if merchant has a registered bin range and credit card used in the transaction outside registered bin range or the transaction is not done using a credit card.
$EbayTransactionID string Its Ebay transaction id. EbayTransactionID will returned for immediate pay item transaction in ECA
$EnhancedPaymentInfo PayPal\EnhancedDataTypes\EnhancedPaymentInfoType This will be enhanced info for the payment: Example: UATP details
$ExchangeRate string Exchange rate for transaction
$ExpectedeCheckClearDate eCheck latest expected clear date
$FMFDetails FMFDetailsType Thes are filters that could result in accept/deny/pending action.
$FeeAmount PayPal\CoreComponentTypes\BasicAmountType Transaction fee associated with the payment
$GrossAmount PayPal\CoreComponentTypes\BasicAmountType Full amount of the customer's payment, before transaction fee is subtracted
$HoldDecision string HoldDecision is returned in the response only if PaymentStatus is Completed-Funds-Held. The reason the funds are kept in pending balance: newsellerpaymenthold: The seller is new. paymenthold: A hold is placed on your transaction due to a reason not listed above.
$InstrumentDetails InstrumentDetailsType Type of the payment instrument.
$InsuranceAmount string Amount of Insurance amount on transaction
$OfferDetails OfferDetailsType Offer Details.
$POSTransactionType string The type of POS transaction F: Forced post transaction. POS merchant can send transactions at a later point if connectivity is lost. S: Single call checkout, and this is to identify PayPal Lite API usage.
$ParentTransactionID string The value of ParentTransactionID is the original OrderID. Character length and limits: 19 single-byte characters maximum
$PaymentDate Date and time of payment
$PaymentError PayPal\EBLBaseComponents\ErrorType This will indicate the payment status for individual payment request in case of split payment
$PaymentRequestID string Unique identifier and mandatory for each bucket in case of split payement
$PaymentStatus string The status of the payment: None: No status Created: A giropay payment has been initiated. Canceled-Reversal: A reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you. Completed: The payment has been completed, and the funds have been added successfully to your account balance. Denied: You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element. Expired: This authorization has expired and cannot be captured. Failed: The payment has failed. This happens only if the payment was made from your customer's bank account. In-Progress: The transaction is in process of authorization and capture. Partially-Refunded: The transaction has been partially refunded. Pending: The payment is pending. See "PendingReason" for more information. Refunded: You refunded the payment. Reversed: A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element. Processed: A payment has been accepted. Voided: This authorization has been voided. Completed-Funds-Held: The payment has been completed, and the funds have been added successfully to your pending balance. See the "HoldDecision" field for more information.
$PaymentType string The type of payment
$PendingReason string authorization: You set PaymentAction to Authorization on SetExpressCheckoutRequest and have not yet captured funds. echeck: The payment is pending because it was made by an eCheck that has not yet cleared. intl: The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview. multi-currency: You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment. unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed. upgrade: The payment is pending because it was made via credit card and you must upgrade your account to Business or Premier status in order to receive the funds. upgrade can also mean that you have reached the monthly limit for transactions on your account. verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment. regulatory-review: This payment is pending while we make sure it meets regulatory requirements. We'll contact you again in 24-72 hours with the outcome of our review. other: The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.
$ProtectionEligibility string Protection Eligibility for this Transaction - None, SPP or ESPP
$ProtectionEligibilityType string Protection Eligibility details for this Transaction
$ReasonCode string guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee. buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer. refund: A reversal has occurred on this transaction because you have given the customer a refund. other: A reversal has occurred on this transaction due to a reason not listed above.
$ReceiptID string Receipt ID Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format
$ReceiptReferenceNumber string Receipt Reference Number for this Transaction
$RefundSourceCodeType string The type of funding source
$SellerDetails SellerDetailsType Details about the seller. Optional
$SettleAmount PayPal\CoreComponentTypes\BasicAmountType Amount deposited into the account's primary balance after a currency conversion from automatic conversion through your Payment Receiving Preferences or manual conversion through manually accepting a payment. This amount is calculated after fees and taxes have been assessed.
$ShipAmount string Amount of shipping charged on transaction
$ShipDiscount string Amount of shipping discount on transaction
$ShipHandleAmount string Amount of ship handling charged on transaction
$ShippingMethod string Shipping method selected by the user during check-out.
$StoreID string StoreID as entered in the transaction
$Subject string Subject as entered in the transaction
$TaxAmount PayPal\CoreComponentTypes\BasicAmountType Amount of tax for transaction
$TerminalID string TerminalID as entered in the transaction
$TransactionID string A transaction identification number. Character length and limits: 19 single-byte characters maximum
$TransactionType string The type of transaction cart: Transaction created via the PayPal Shopping Cart feature or by Express Checkout with multiple purchased item express-checkout: Transaction created by Express Checkout with a single purchased items send-money: Transaction created by customer from the Send Money tab on the PayPal website. web-accept: Transaction created by customer via Buy Now, Donation, or Auction Smart Logos. subscr-*: Transaction created by customer via Subscription. eot means "end of subscription term." merch-pmt: preapproved payment. mass-pay: Transaction created via MassPay. virtual-terminal: Transaction created via merchant virtual terminal. credit: Transaction created via merchant virtual terminal or API to credit a customer.

Property Details

$BinEligibility public property

This field indicates whether the credit card number used for this transaction is in a particular bin range registered with PayPal by the merchant. This filed is optional and will be present if merchant has a registered bin range. The value of this field will be "true" if merchant has a registered bin range and the credit card used in the transaction is within the registered bin range. The value of this field will be false if merchant has a registered bin range and credit card used in the transaction outside registered bin range or the transaction is not done using a credit card.
public string $BinEligibility
return string

$EbayTransactionID public property

Its Ebay transaction id. EbayTransactionID will returned for immediate pay item transaction in ECA
public string $EbayTransactionID
return string

$EnhancedPaymentInfo public property

This will be enhanced info for the payment: Example: UATP details
public EnhancedPaymentInfoType,PayPal\EnhancedDataTypes $EnhancedPaymentInfo
return PayPal\EnhancedDataTypes\EnhancedPaymentInfoType

$ExchangeRate public property

Exchange rate for transaction
public string $ExchangeRate
return string

$ExpectedeCheckClearDate public property

eCheck latest expected clear date
public $ExpectedeCheckClearDate

$FMFDetails public property

Thes are filters that could result in accept/deny/pending action.
public FMFDetailsType,PayPal\EBLBaseComponents $FMFDetails
return FMFDetailsType

$FeeAmount public property

Transaction fee associated with the payment
public BasicAmountType,PayPal\CoreComponentTypes $FeeAmount
return PayPal\CoreComponentTypes\BasicAmountType

$GrossAmount public property

Full amount of the customer's payment, before transaction fee is subtracted
public BasicAmountType,PayPal\CoreComponentTypes $GrossAmount
return PayPal\CoreComponentTypes\BasicAmountType

$HoldDecision public property

HoldDecision is returned in the response only if PaymentStatus is Completed-Funds-Held. The reason the funds are kept in pending balance: newsellerpaymenthold: The seller is new. paymenthold: A hold is placed on your transaction due to a reason not listed above.
public string $HoldDecision
return string

$InstrumentDetails public property

Type of the payment instrument.
public InstrumentDetailsType,PayPal\EBLBaseComponents $InstrumentDetails
return InstrumentDetailsType

$InsuranceAmount public property

Amount of Insurance amount on transaction
public string $InsuranceAmount
return string

$OfferDetails public property

Offer Details.
public OfferDetailsType,PayPal\EBLBaseComponents $OfferDetails
return OfferDetailsType

$POSTransactionType public property

The type of POS transaction F: Forced post transaction. POS merchant can send transactions at a later point if connectivity is lost. S: Single call checkout, and this is to identify PayPal Lite API usage.
public string $POSTransactionType
return string

$ParentTransactionID public property

The value of ParentTransactionID is the original OrderID. Character length and limits: 19 single-byte characters maximum
public string $ParentTransactionID
return string

$PaymentDate public property

Date and time of payment
public $PaymentDate

$PaymentError public property

This will indicate the payment status for individual payment request in case of split payment
public ErrorType,PayPal\EBLBaseComponents $PaymentError
return PayPal\EBLBaseComponents\ErrorType

$PaymentRequestID public property

Unique identifier and mandatory for each bucket in case of split payement
public string $PaymentRequestID
return string

$PaymentStatus public property

The status of the payment: None: No status Created: A giropay payment has been initiated. Canceled-Reversal: A reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you. Completed: The payment has been completed, and the funds have been added successfully to your account balance. Denied: You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element. Expired: This authorization has expired and cannot be captured. Failed: The payment has failed. This happens only if the payment was made from your customer's bank account. In-Progress: The transaction is in process of authorization and capture. Partially-Refunded: The transaction has been partially refunded. Pending: The payment is pending. See "PendingReason" for more information. Refunded: You refunded the payment. Reversed: A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element. Processed: A payment has been accepted. Voided: This authorization has been voided. Completed-Funds-Held: The payment has been completed, and the funds have been added successfully to your pending balance. See the "HoldDecision" field for more information.
public string $PaymentStatus
return string

$PaymentType public property

The type of payment
public string $PaymentType
return string

$PendingReason public property

authorization: You set PaymentAction to Authorization on SetExpressCheckoutRequest and have not yet captured funds. echeck: The payment is pending because it was made by an eCheck that has not yet cleared. intl: The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview. multi-currency: You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment. unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed. upgrade: The payment is pending because it was made via credit card and you must upgrade your account to Business or Premier status in order to receive the funds. upgrade can also mean that you have reached the monthly limit for transactions on your account. verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment. regulatory-review: This payment is pending while we make sure it meets regulatory requirements. We'll contact you again in 24-72 hours with the outcome of our review. other: The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.
public string $PendingReason
return string

$ProtectionEligibility public property

Protection Eligibility for this Transaction - None, SPP or ESPP
public string $ProtectionEligibility
return string

$ProtectionEligibilityType public property

Protection Eligibility details for this Transaction
public string $ProtectionEligibilityType
return string

$ReasonCode public property

guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee. buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer. refund: A reversal has occurred on this transaction because you have given the customer a refund. other: A reversal has occurred on this transaction due to a reason not listed above.
public string $ReasonCode
return string

$ReceiptID public property

Receipt ID Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format
public string $ReceiptID
return string

$ReceiptReferenceNumber public property

Receipt Reference Number for this Transaction
public string $ReceiptReferenceNumber
return string

$RefundSourceCodeType public property

The type of funding source
public string $RefundSourceCodeType
return string

$SellerDetails public property

Details about the seller. Optional
public SellerDetailsType,PayPal\EBLBaseComponents $SellerDetails
return SellerDetailsType

$SettleAmount public property

Amount deposited into the account's primary balance after a currency conversion from automatic conversion through your Payment Receiving Preferences or manual conversion through manually accepting a payment. This amount is calculated after fees and taxes have been assessed.
public BasicAmountType,PayPal\CoreComponentTypes $SettleAmount
return PayPal\CoreComponentTypes\BasicAmountType

$ShipAmount public property

Amount of shipping charged on transaction
public string $ShipAmount
return string

$ShipDiscount public property

Amount of shipping discount on transaction
public string $ShipDiscount
return string

$ShipHandleAmount public property

Amount of ship handling charged on transaction
public string $ShipHandleAmount
return string

$ShippingMethod public property

Shipping method selected by the user during check-out.
public string $ShippingMethod
return string

$StoreID public property

StoreID as entered in the transaction
public string $StoreID
return string

$Subject public property

Subject as entered in the transaction
public string $Subject
return string

$TaxAmount public property

Amount of tax for transaction
public BasicAmountType,PayPal\CoreComponentTypes $TaxAmount
return PayPal\CoreComponentTypes\BasicAmountType

$TerminalID public property

TerminalID as entered in the transaction
public string $TerminalID
return string

$TransactionID public property

A transaction identification number. Character length and limits: 19 single-byte characters maximum
public string $TransactionID
return string

$TransactionType public property

The type of transaction cart: Transaction created via the PayPal Shopping Cart feature or by Express Checkout with multiple purchased item express-checkout: Transaction created by Express Checkout with a single purchased items send-money: Transaction created by customer from the Send Money tab on the PayPal website. web-accept: Transaction created by customer via Buy Now, Donation, or Auction Smart Logos. subscr-*: Transaction created by customer via Subscription. eot means "end of subscription term." merch-pmt: preapproved payment. mass-pay: Transaction created via MassPay. virtual-terminal: Transaction created via merchant virtual terminal. credit: Transaction created via merchant virtual terminal or API to credit a customer.
public string $TransactionType
return string