OrdersApi class

Orders API interface

Constructors

OrdersApi(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

authorizePaymentForOrder(String id, {PaymentSourceToken? paymentSource, String? payPalRequestId, String? payPalAuthAssertion, String? payPalClientMetadataId, Prefer? prefer}) → Future<Order>

Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

capturePayment(String id, {PaymentSourceToken? paymentSource, String? payPalRequestId, String? payPalAuthAssertion, String? payPalClientMetadataId, Prefer? prefer}) → Future<Order>

Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid payment_source must be provided in the request. A buyer can approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the create order response.

createOrder(OrderRequest request, {String? payPalRequestId, String? payPalPartnerAttributionId, String? payPalClientMetadataId, Prefer? prefer}) → Future<Order>

Creates an order

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

showOrderDetails(String id, {List<String>? fields}) → Future<Order>

Shows details for an order, by ID.

toString() → String

A string representation of this object.

inherited

updateOrder(String id, List<Patch> patchRequests) → Future<void>

Updates an order with a CREATED or APPROVED status. You cannot update an order with the COMPLETED status.

Operators

operator ==(Object other) → bool

The equality operator.

inherited