CaptureRequest class

Captured payment details request body

Annotations
  • @JsonSerializable(fieldRename: FieldRename.snake)

Constructors

CaptureRequest({String? invoiceId, String? noteToPayer, Money? amount, bool? finalCapture, PaymentInstruction? paymentInstruction, String? softDescriptor})
const
CaptureRequest.fromJson(Map<String, dynamic> json)
factory

Properties

amount Money?
The amount to capture. To capture a portion of the full authorized amount, specify an amount. If amount is not specified, the full authorized amount is captured. The amount must be a positive number and in the same currency as the authorization against which the payment is being captured.
final
finalCapture bool?
Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.
final
hashCode int
The hash code for this object.
no setterinherited
invoiceId String?
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
final
noteToPayer String?
An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.
final
paymentInstruction PaymentInstruction?
Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
softDescriptor String?
The payment descriptor on the payer's account statement.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited