Payment Type

This type describes the payment that has been processed with PayPal.

Remarks

The type is readonly and will be populated after a response from the server that contains payment information.

Fields

This is the time/date stamp of payment.

Exchange rate if a currency conversion occurred.

Relevant only if you are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer's account.

FeeAmount
String

PayPal fee amount charged for the transaction.

GrossAmount
String

The final amount charged.

This includes any shipping and taxes from your Merchant Profile.

PaymentType
String

Indicates whether the payment is instant or delayed.

Current list of return values: none, echeck, instant.

PendingReason
String

The reason the payment is pending.

The current list of possible return values for this property are:


Response	Description
none	No pending reason.
address	The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
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.
PaymentReview	The payment is under review by PayPal. Check PaymentProtectionEligibility for protection eligibility status.
verify	The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
other	The payment is pending for a reason other than those listed above. For more information, contact PayPal customer service.

SettleAmount
String

Amount deposited in your PayPal account after a currency conversion.

If there is no currency conversion, this property will remain empty.

Status
String

Status of the payment.

The current list of possible values for this property are:


Response	Description
None	No status.
Canceled-Reversal	A reversal has been canceled.
Completed	The payment has been completed and the funds have been added successfully to your account balance.
Denied	You denied the payment.
Failed	The payment has failed.
Pending	The payment is pending.
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.
Processed	A payment has been accepted.

Note: When the returned value of this property is...

- "Canceled-Reversal": it means that 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.

- "Denied": this happens only if the payment was previously pending because of possible reasons described for the PendingReason element.

- "Failed": this happens only if the payment was made from your customer's bank account.

- "Pending": see the PendingReason field for more information.

TaxAmount
String

Tax charged on the transaction.

TransactionId
String

Unique transaction ID of the payment.

TransactionType
String

The type of transaction.

Current list of return values: cart, express-checkout.

Constructors

public Payment();