| Метод |
Описание |
|
|
addPaymentHoldReason ( string $string ) |
Append PaymentHoldReasons to the list. |
|
|
get ( string $saleId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Sale |
Shows details for a sale, by ID. Returns only sales that were created through the REST API. |
|
|
getAmount ( ) : Amount |
Amount being collected. |
|
|
getBillingAgreementId ( ) : string |
ID of the billing agreement used as reference to execute this transaction. |
|
|
getClearingTime ( ) : string |
Expected clearing time for eCheck Transactions. Returned when payment is made with eCheck. Only supported when the payment_method is set to paypal. |
|
|
getCreateTime ( ) : string |
Time of sale as defined in RFC 3339 Section 5.6 |
|
|
getExchangeRate ( ) : string |
Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. |
|
|
getFmfDetails ( ) : FmfDetails |
Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See Fraud Management Filters Summary for more information. |
|
|
getId ( ) : string |
Identifier of the sale transaction. |
|
|
getParentPayment ( ) : string |
ID of the payment resource on which this transaction is based. |
|
|
getPaymentHoldReasons ( ) : string[] |
Reasons for PayPal holding recipient fund. It is set only if payment hold status is held |
|
|
getPaymentHoldStatus ( ) : string |
Status of the Recipient Fund. For now, it will be returned only when fund status is held |
|
|
getPaymentMode ( ) : string |
Specifies payment mode of the transaction. Only supported when the payment_method is set to paypal. |
|
|
getProcessorResponse ( ) : PayPal\Api\ProcessorResponse |
Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card. |
|
|
getProtectionEligibility ( ) : string |
The level of seller protection in force for the transaction. Only supported when the payment_method is set to paypal. |
|
|
getProtectionEligibilityType ( ) : string |
The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the payment_method is set to paypal. |
|
|
getPurchaseUnitReferenceId ( ) : string |
Identifier to the purchase or transaction unit corresponding to this sale transaction. |
|
|
getReasonCode ( ) : string |
Reason code for the transaction state being Pending or Reversed. Only supported when the payment_method is set to paypal. |
|
|
getReceiptId ( ) : string |
Receipt id is a payment identification number returned for guest users to identify the payment. |
|
|
getReceivableAmount ( ) : PayPal\Api\Currency |
Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. |
|
|
getState ( ) : string |
State of the sale transaction. |
|
|
getTransactionFee ( ) : PayPal\Api\Currency |
Transaction fee applicable for this payment. |
|
|
getUpdateTime ( ) : string |
Time the resource was last updated in UTC ISO8601 format. |
|
|
refund ( Refund $refund, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Refund |
Refund a completed payment by passing the sale_id in the request URI. In addition, include an empty JSON payload in the request body for a full refund. For a partial refund, include an amount object in the request body. |
|
|
refundSale ( RefundRequest $refundRequest, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : DetailedRefund |
Refunds a sale, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body. |
|
|
removePaymentHoldReason ( string $string ) |
Remove PaymentHoldReasons from the list. |
|
|
setAmount ( Amount $amount ) |
Amount being collected. |
|
|
setBillingAgreementId ( string $billing_agreement_id ) |
ID of the billing agreement used as reference to execute this transaction. |
|
|
setClearingTime ( string $clearing_time ) |
Expected clearing time for eCheck Transactions. Returned when payment is made with eCheck. Only supported when the payment_method is set to paypal. |
|
|
setCreateTime ( string $create_time ) |
Time of sale as defined in RFC 3339 Section 5.6 |
|
|
setExchangeRate ( string $exchange_rate ) |
Exchange rate applied for this transaction. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. |
|
|
setFmfDetails ( FmfDetails $fmf_details ) |
Fraud Management Filter (FMF) details applied for the payment that could result in accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. See Fraud Management Filters Summary for more information. |
|
|
setId ( string $id ) |
Identifier of the sale transaction. |
|
|
setParentPayment ( string $parent_payment ) |
ID of the payment resource on which this transaction is based. |
|
|
setPaymentHoldReasons ( string[] $payment_hold_reasons ) |
Reasons for PayPal holding recipient fund. It is set only if payment hold status is held |
|
|
setPaymentHoldStatus ( string $payment_hold_status ) |
Status of the Recipient Fund. For now, it will be returned only when fund status is held
Valid Values: ["HELD"] |
|
|
setPaymentMode ( string $payment_mode ) |
Specifies payment mode of the transaction. Only supported when the payment_method is set to paypal. |
|
|
setProcessorResponse ( PayPal\Api\ProcessorResponse $processor_response ) |
Response codes returned by the processor concerning the submitted payment. Only supported when the payment_method is set to credit_card. |
|
|
setProtectionEligibility ( string $protection_eligibility ) |
The level of seller protection in force for the transaction. Only supported when the payment_method is set to paypal. |
|
|
setProtectionEligibilityType ( string $protection_eligibility_type ) |
The kind of seller protection in force for the transaction. It is returned only when protection_eligibility is ELIGIBLE or PARTIALLY_ELIGIBLE. Only supported when the payment_method is set to paypal. |
|
|
setPurchaseUnitReferenceId ( string $purchase_unit_reference_id ) |
Identifier to the purchase or transaction unit corresponding to this sale transaction. |
|
|
setReasonCode ( string $reason_code ) |
Reason code for the transaction state being Pending or Reversed. Only supported when the payment_method is set to paypal. |
|
|
setReceiptId ( string $receipt_id ) |
Receipt id is a payment identification number returned for guest users to identify the payment. |
|
|
setReceivableAmount ( PayPal\Api\Currency $receivable_amount ) |
Net amount the merchant receives for this transaction in their receivable currency. Returned only in cross-currency use cases where a merchant bills a buyer in a non-primary currency for that buyer. |
|
|
setState ( string $state ) |
State of the sale transaction. |
|
|
setTransactionFee ( PayPal\Api\Currency $transaction_fee ) |
Transaction fee applicable for this payment. |
|
|
setUpdateTime ( string $update_time ) |
Time the resource was last updated in UTC ISO8601 format. |
|