PHP 클래스 PayPal\Api\Capture

상속: extends Resource
파일 보기 프로젝트 열기: paypal/rest-api-sdk-php 1 사용 예제들

공개 메소드들

메소드 설명
get ( string $captureId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Capture Shows details for a captured payment, by ID.
getAmount ( ) : Amount The amount to capture. If the amount matches the orginally authorized amount, the state of the authorization changes to captured. If not, the state of the authorization changes to partially_captured.
getCreateTime ( ) : string The date and time of capture, as defined in RFC 3339 Section 5.6.
getId ( ) : string The ID of the capture transaction.
getInvoiceNumber ( ) : string The invoice number to track this payment.
getIsFinalCapture ( ) : boolean Indicates whether to release all remaining funds that the authorization holds in the funding instrument. Default is false.
getParentPayment ( ) : string The ID of the payment on which this transaction is based.
getReasonCode ( ) : string The reason code that describes why the transaction state is pending or reversed.
getState ( ) : string The state of the capture.
getTransactionFee ( ) : PayPal\Api\Currency The transaction fee for this payment.
getUpdateTime ( ) : string The date and time when the resource was last updated.
refund ( Refund $refund, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Refund Refund a captured payment by passing the capture_id in the request URI. In addition, include an amount object in the body of the request JSON.
refundCapturedPayment ( RefundRequest $refundRequest, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : DetailedRefund Refunds a captured payment, by ID. Include an amount object in the JSON request body.
setAmount ( Amount $amount ) The amount to capture. If the amount matches the orginally authorized amount, the state of the authorization changes to captured. If not, the state of the authorization changes to partially_captured.
setCreateTime ( string $create_time ) The date and time of capture, as defined in RFC 3339 Section 5.6.
setId ( string $id ) The ID of the capture transaction.
setInvoiceNumber ( string $invoice_number ) The invoice number to track this payment.
setIsFinalCapture ( boolean $is_final_capture ) Indicates whether to release all remaining funds that the authorization holds in the funding instrument. Default is false.
setParentPayment ( string $parent_payment ) The ID of the payment on which this transaction is based.
setReasonCode ( string $reason_code ) The reason code that describes why the transaction state is pending or reversed.
setState ( string $state ) The state of the capture.
setTransactionFee ( PayPal\Api\Currency $transaction_fee ) The transaction fee for this payment.
setUpdateTime ( string $update_time ) The date and time when the resource was last updated.

메소드 상세

get() 공개 정적인 메소드

Shows details for a captured payment, by ID.
public static get ( string $captureId, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Capture
$captureId string
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
리턴 Capture

getAmount() 공개 메소드

The amount to capture. If the amount matches the orginally authorized amount, the state of the authorization changes to captured. If not, the state of the authorization changes to partially_captured.
public getAmount ( ) : Amount
리턴 Amount

getCreateTime() 공개 메소드

The date and time of capture, as defined in RFC 3339 Section 5.6.
public getCreateTime ( ) : string
리턴 string

getId() 공개 메소드

The ID of the capture transaction.
public getId ( ) : string
리턴 string

getInvoiceNumber() 공개 메소드

The invoice number to track this payment.
public getInvoiceNumber ( ) : string
리턴 string

getIsFinalCapture() 공개 메소드

Indicates whether to release all remaining funds that the authorization holds in the funding instrument. Default is false.
public getIsFinalCapture ( ) : boolean
리턴 boolean

getParentPayment() 공개 메소드

The ID of the payment on which this transaction is based.
public getParentPayment ( ) : string
리턴 string

getReasonCode() 공개 메소드

The reason code that describes why the transaction state is pending or reversed.
public getReasonCode ( ) : string
리턴 string

getState() 공개 메소드

The state of the capture.
public getState ( ) : string
리턴 string

getTransactionFee() 공개 메소드

The transaction fee for this payment.
public getTransactionFee ( ) : PayPal\Api\Currency
리턴 PayPal\Api\Currency

getUpdateTime() 공개 메소드

The date and time when the resource was last updated.
public getUpdateTime ( ) : string
리턴 string

refund() 공개 메소드

Refund a captured payment by passing the capture_id in the request URI. In addition, include an amount object in the body of the request JSON.
사용 중단: Please use #refundCapturedPayment instead.
public refund ( Refund $refund, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : Refund
$refund Refund
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
리턴 Refund

refundCapturedPayment() 공개 메소드

Refunds a captured payment, by ID. Include an amount object in the JSON request body.
public refundCapturedPayment ( RefundRequest $refundRequest, ApiContext $apiContext = null, PayPalRestCall $restCall = null ) : DetailedRefund
$refundRequest RefundRequest
$apiContext PayPal\Rest\ApiContext is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall PayPal\Transport\PayPalRestCall is the Rest Call Service that is used to make rest calls
리턴 DetailedRefund

setAmount() 공개 메소드

The amount to capture. If the amount matches the orginally authorized amount, the state of the authorization changes to captured. If not, the state of the authorization changes to partially_captured.
public setAmount ( Amount $amount )
$amount Amount

setCreateTime() 공개 메소드

The date and time of capture, as defined in RFC 3339 Section 5.6.
public setCreateTime ( string $create_time )
$create_time string

setId() 공개 메소드

The ID of the capture transaction.
public setId ( string $id )
$id string

setInvoiceNumber() 공개 메소드

The invoice number to track this payment.
public setInvoiceNumber ( string $invoice_number )
$invoice_number string

setIsFinalCapture() 공개 메소드

Indicates whether to release all remaining funds that the authorization holds in the funding instrument. Default is false.
public setIsFinalCapture ( boolean $is_final_capture )
$is_final_capture boolean

setParentPayment() 공개 메소드

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

setReasonCode() 공개 메소드

Valid Values: ["CHARGEBACK", "GUARANTEE", "BUYER_COMPLAINT", "REFUND", "UNCONFIRMED_SHIPPING_ADDRESS", "ECHECK", "INTERNATIONAL_WITHDRAWAL", "RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION", "PAYMENT_REVIEW", "REGULATORY_REVIEW", "UNILATERAL", "VERIFICATION_REQUIRED", "TRANSACTION_APPROVED_AWAITING_FUNDING"]
public setReasonCode ( string $reason_code )
$reason_code string

setState() 공개 메소드

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

setTransactionFee() 공개 메소드

The transaction fee for this payment.
public setTransactionFee ( PayPal\Api\Currency $transaction_fee )
$transaction_fee PayPal\Api\Currency

setUpdateTime() 공개 메소드

The date and time when the resource was last updated.
public setUpdateTime ( string $update_time )
$update_time string