PHP Class PayPal\Api\Refund

A refund transaction.
Inheritance: extends PayPal\Common\PayPalResourceModel
Afficher le fichier Open project: paypal/rest-api-sdk-php Class Usage Examples

Méthodes publiques

Méthode Description
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.

Method Details

get() public static méthode

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
Résultat Refund

getAmount() public méthode

Details including both refunded amount (to payer) and refunded fee (to payee). 10 characters max.
public getAmount ( ) : Amount
Résultat Amount

getCaptureId() public méthode

ID of the sale transaction being refunded.
public getCaptureId ( ) : string
Résultat string

getCreateTime() public méthode

Time of refund as defined in RFC 3339 Section 5.6.
public getCreateTime ( ) : string
Résultat string

getDescription() public méthode

Description of what is being refunded for.
public getDescription ( ) : string
Résultat string

getId() public méthode

ID of the refund transaction. 17 characters max.
public getId ( ) : string
Résultat string

getInvoiceNumber() public méthode

Your own invoice or tracking ID number. Character length and limitations: 127 single-byte alphanumeric characters.
public getInvoiceNumber ( ) : string
Résultat string

getParentPayment() public méthode

ID of the payment resource on which this transaction is based.
public getParentPayment ( ) : string
Résultat string

getReason() public méthode

Reason description for the Sale transaction being refunded.
public getReason ( ) : string
Résultat string

getReasonCode() public méthode

The reason code for the refund state being pending
public getReasonCode ( ) : string
Résultat string

getSaleId() public méthode

ID of the Sale transaction being refunded.
public getSaleId ( ) : string
Résultat string

getState() public méthode

State of the refund.
public getState ( ) : string
Résultat string

getUpdateTime() public méthode

Time that the resource was last updated.
public getUpdateTime ( ) : string
Résultat string

setAmount() public méthode

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

setCaptureId() public méthode

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

setCreateTime() public méthode

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

setDescription() public méthode

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

setId() public méthode

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

setInvoiceNumber() public méthode

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() public méthode

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

setReason() public méthode

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

setReasonCode() public méthode

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

setSaleId() public méthode

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

setState() public méthode

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

setUpdateTime() public méthode

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