PHP 클래스 PayPal\Api\Refund

A refund transaction.
상속: extends PayPal\Common\PayPalResourceModel
파일 보기 프로젝트 열기: paypal/rest-api-sdk-php 1 사용 예제들

공개 메소드들

메소드 설명
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