PHP Class PayPal\Api\PaymentDetail

Invoicing payment information.

Inheritance: extends PayPal\Common\PayPalModel

Show file Open project: paypal/rest-api-sdk-php Class Usage Examples

Public Methods

Method	Description
getAmount ( ) : PayPal\Api\Currency	The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment.
getDate ( ) : string	The date when the invoice was paid. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format.
getMethod ( ) : string	The payment mode or method. Required with the EXTERNAL payment type.
getNote ( ) : string	Optional. A note associated with the payment.
getTransactionId ( ) : string	The PayPal payment transaction ID. Required with the PAYPAL payment type.
getTransactionType ( ) : string	Type of the transaction.
getType ( ) : string	The PayPal payment detail. Indicates whether payment was made in an invoicing flow through PayPal or externally. In the case of the mark-as-paid API, the supported payment type is EXTERNAL. For backward compatibility, the PAYPAL payment type is still supported.
setAmount ( PayPal\Api\Currency $amount )	The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment.
setDate ( string $date )	The date when the invoice was paid. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format.
setMethod ( string $method )	The payment mode or method. Required with the EXTERNAL payment type.
setNote ( string $note )	Optional. A note associated with the payment.
setTransactionId ( string $transaction_id )	The PayPal payment transaction ID. Required with the PAYPAL payment type.
setTransactionType ( string $transaction_type )	Type of the transaction.
setType ( string $type )	The PayPal payment detail. Indicates whether payment was made in an invoicing flow through PayPal or externally. In the case of the mark-as-paid API, the supported payment type is EXTERNAL. For backward compatibility, the PAYPAL payment type is still supported.

Method Details

getAmount() public method

The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment.

public getAmount ( ) : PayPal\Api\Currency
return	PayPal\Api\Currency

getDate() public method

The date when the invoice was paid. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.

public getDate ( ) : string
return	string

getMethod() public method

The payment mode or method. Required with the EXTERNAL payment type.

public getMethod ( ) : string
return	string

getNote() public method

Optional. A note associated with the payment.

public getNote ( ) : string
return	string

getTransactionId() public method

The PayPal payment transaction ID. Required with the PAYPAL payment type.

public getTransactionId ( ) : string
return	string

getTransactionType() public method

Type of the transaction.

public getTransactionType ( ) : string
return	string

getType() public method

The PayPal payment detail. Indicates whether payment was made in an invoicing flow through PayPal or externally. In the case of the mark-as-paid API, the supported payment type is EXTERNAL. For backward compatibility, the PAYPAL payment type is still supported.

public getType ( ) : string
return	string

setAmount() public method

The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment.

public setAmount ( PayPal\Api\Currency $amount )
$amount	PayPal\Api\Currency

setDate() public method

The date when the invoice was paid. The date format is *yyyy*-*MM*-*dd* *z* as defined in Internet Date/Time Format.

public setDate ( string $date )
$date	string

setMethod() public method

Valid Values: ["BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"]

public setMethod ( string $method )
$method	string

setNote() public method

Optional. A note associated with the payment.

public setNote ( string $note )
$note	string

setTransactionId() public method

The PayPal payment transaction ID. Required with the PAYPAL payment type.

public setTransactionId ( string $transaction_id )
$transaction_id	string

setTransactionType() public method

Valid Values: ["SALE", "AUTHORIZATION", "CAPTURE"]

public setTransactionType ( string $transaction_type )
$transaction_type	string

setType() public method

Valid Values: ["PAYPAL", "EXTERNAL"]

public setType ( string $type )
$type	string