Class PaymentDetail

Class PaymentDetail

Invoicing payment information.

PayPal\Common\PayPalModel

Extended by

PayPal\Api\PaymentDetail

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/PaymentDetail.php

Methods summary

`public`	# `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. Valid Values: ["PAYPAL", "EXTERNAL"] 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. Valid Values: ["PAYPAL", "EXTERNAL"] Parameters `$type` Returns $this
`public string`	# `getType( )` 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. 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. Returns string
`public`	# `setTransactionId( string $transaction_id )` The PayPal payment transaction ID. Required with the `PAYPAL` payment type. The PayPal payment transaction ID. Required with the `PAYPAL` payment type. Parameters `$transaction_id` Returns $this
`public string`	# `getTransactionId( )` The PayPal payment transaction ID. Required with the `PAYPAL` payment type. The PayPal payment transaction ID. Required with the `PAYPAL` payment type. Returns string
`public`	# `setTransactionType( string $transaction_type )` Type of the transaction. Valid Values: ["SALE", "AUTHORIZATION", "CAPTURE"] Type of the transaction. Valid Values: ["SALE", "AUTHORIZATION", "CAPTURE"] Parameters `$transaction_type` Returns $this
`public string`	# `getTransactionType( )` Type of the transaction. Type of the transaction. Returns string
`public`	# `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. The date when the invoice was paid. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format. Parameters `$date` Returns $this
`public string`	# `getDate( )` The date when the invoice was paid. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format. The date when the invoice was paid. The date format is yyyy-MM-dd z as defined in Internet Date/Time Format. Returns string
`public`	# `setMethod( string $method )` The payment mode or method. Required with the `EXTERNAL` payment type. Valid Values: ["BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"] The payment mode or method. Required with the `EXTERNAL` payment type. Valid Values: ["BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"] Parameters `$method` Returns $this
`public string`	# `getMethod( )` The payment mode or method. Required with the `EXTERNAL` payment type. The payment mode or method. Required with the `EXTERNAL` payment type. Returns string
`public`	# `setNote( string $note )` Optional. A note associated with the payment. Optional. A note associated with the payment. Parameters `$note` Returns $this
`public string`	# `getNote( )` Optional. A note associated with the payment. Optional. A note associated with the payment. Returns string
`public`	# `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. The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment. Parameters `$amount` Returns $this
`public PayPal\Api\Currency`	# `getAmount( )` The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment. The amount to record as payment against invoice. If you omit this parameter, the total invoice amount is recorded as payment. Returns `PayPal\Api\Currency`

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel