PHP Класс PayPal\Api\Refund

A refund transaction.
Наследование: extends PayPal\Common\PayPalResourceModel
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
get ( string $refundId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Refund Shows details for a refund, by ID.
getAmount ( ) : Amount Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
getCaptureId ( ) : string ID of the sale transaction being refunded.
getCreateTime ( ) : string Time of refund as defined in RFC 3339 Section 5.6.
getDescription ( ) : string Description of what is being refunded for.
getId ( ) : string ID of the refund transaction. 17 characters max.
getInvoiceNumber ( ) : string Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters.
getParentPayment ( ) : string ID of the payment resource on which this transaction is based.
getReason ( ) : string Reason description for the Sale transaction being refunded.
getReasonCode ( ) : string The reason code for the refund state being pending
getSaleId ( ) : string ID of the Sale transaction being refunded.
getState ( ) : string State of the refund.
getUpdateTime ( ) : string Time that the resource was last updated.
setAmount ( Amount $amount ) Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
setCaptureId ( string $capture_id ) ID of the sale transaction being refunded.
setCreateTime ( string $create_time ) Time of refund as defined in RFC 3339 Section 5.6.
setDescription ( string $description ) Description of what is being refunded for.
setId ( string $id ) ID of the refund transaction. 17 characters max.
setInvoiceNumber ( string $invoice_number ) Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters.
setParentPayment ( string $parent_payment ) ID of the payment resource on which this transaction is based.
setReason ( string $reason ) Reason description for the Sale transaction being refunded.
setReasonCode ( string $reason_code ) The reason code for the refund state being pending Valid Values: ["ECHECK"]
setSaleId ( string $sale_id ) ID of the Sale transaction being refunded.
setState ( string $state ) State of the refund.
setUpdateTime ( string $update_time ) Time that the resource was last updated.

Описание методов

get() публичный статический Метод

Shows details for a refund, by ID.
public static get ( string $refundId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Refund
$refundId string
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPalRestCall is the Rest Call Service that is used to make rest calls
Результат Refund

getAmount() публичный Метод

Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
public getAmount ( ) : Amount
Результат Amount

getCaptureId() публичный Метод

ID of the sale transaction being refunded.
public getCaptureId ( ) : string
Результат string

getCreateTime() публичный Метод

Time of refund as defined in RFC 3339 Section 5.6.
public getCreateTime ( ) : string
Результат string

getDescription() публичный Метод

Description of what is being refunded for.
public getDescription ( ) : string
Результат string

getId() публичный Метод

ID of the refund transaction. 17 characters max.
public getId ( ) : string
Результат string

getInvoiceNumber() публичный Метод

Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters.
public getInvoiceNumber ( ) : string
Результат string

getParentPayment() публичный Метод

ID of the payment resource on which this transaction is based.
public getParentPayment ( ) : string
Результат string

getReason() публичный Метод

Reason description for the Sale transaction being refunded.
public getReason ( ) : string
Результат string

getReasonCode() публичный Метод

The reason code for the refund state being pending
public getReasonCode ( ) : string
Результат string

getSaleId() публичный Метод

ID of the Sale transaction being refunded.
public getSaleId ( ) : string
Результат string

getState() публичный Метод

State of the refund.
public getState ( ) : string
Результат string

getUpdateTime() публичный Метод

Time that the resource was last updated.
public getUpdateTime ( ) : string
Результат string

setAmount() публичный Метод

Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
public setAmount ( Amount $amount )
$amount Amount

setCaptureId() публичный Метод

ID of the sale transaction being refunded.
public setCaptureId ( string $capture_id )
$capture_id string

setCreateTime() публичный Метод

Time of refund as defined in RFC 3339 Section 5.6.
public setCreateTime ( string $create_time )
$create_time string

setDescription() публичный Метод

Description of what is being refunded for.
public setDescription ( string $description )
$description string

setId() публичный Метод

ID of the refund transaction. 17 characters max.
public setId ( string $id )
$id string

setInvoiceNumber() публичный Метод

Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters.
public setInvoiceNumber ( string $invoice_number )
$invoice_number string

setParentPayment() публичный Метод

ID of the payment resource on which this transaction is based.
public setParentPayment ( string $parent_payment )
$parent_payment string

setReason() публичный Метод

Reason description for the Sale transaction being refunded.
public setReason ( string $reason )
$reason string

setReasonCode() публичный Метод

The reason code for the refund state being pending Valid Values: ["ECHECK"]
public setReasonCode ( string $reason_code )
$reason_code string

setSaleId() публичный Метод

ID of the Sale transaction being refunded.
public setSaleId ( string $sale_id )
$sale_id string

setState() публичный Метод

Valid Values: ["pending", "completed", "failed"]
public setState ( string $state )
$state string

setUpdateTime() публичный Метод

Time that the resource was last updated.
public setUpdateTime ( string $update_time )
$update_time string