PaymentsApi class

Payments API interface

Constructors

PaymentsApi(PayPalHttpClient payPalHttpClient)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

captureAuthorizedPayment(String authorizationId, CaptureRequest request, {String? payPalRequestId, Prefer? prefer}) → Future<Capture>

Captures an authorized payment, by ID.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reauthorizeAuthorizedPayment(String authorizationId, Money amount, {String? payPalRequestId, Prefer? prefer}) → Future<Authorization>

Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.

refundCapturedPayment(String captureId, RefundRequest request, {String? payPalRequestId, String? payPalAuthAssertion}) → Future<Refund>

Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.

showCapturedPaymentDetails(String captureId) → Future<Capture>

Shows details for a captured payment, by ID.

showDetailsForAuthorizedPayment(String authorizationId) → Future<Authorization>

Shows details for an authorized payment, by ID.

showRefundDetails(String refundId) → Future<Refund>

Shows details for a refund, by ID.

toString() → String

A string representation of this object.

inherited

voidAuthorizedPayment(String authorizationId, {String? payPalAuthAssertion}) → Future<void>

Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.

Operators

operator ==(Object other) → bool

The equality operator.

inherited