CaptureRequest class abstract

CaptureRequest

Properties:

  • additionalData - This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.
  • merchantAccount - The merchant account that is used to process the payment.
  • modificationAmount - The amount that needs to be captured. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
  • mpiData - Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
  • originalMerchantReference - The original merchant reference to cancel.
  • originalReference - The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
  • platformChargebackLogic - Defines how to book chargebacks when using Adyen for Platforms.
  • reference - Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
  • splits - An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for platforms.
  • tenderReference - The transaction reference provided by the PED. For point-of-sale integrations only.
  • uniqueTerminalId - Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
Annotations
  • @BuiltValue.new()

Constructors

CaptureRequest([void updates(CaptureRequestBuilder b)])
factory

Properties

additionalData → BuiltMap<String, String>?
This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value.
no setter
hashCode → int
The hash code for this object.
no setterinherited
merchantAccount → String
The merchant account that is used to process the payment.
no setter
modificationAmount → Amount
The amount that needs to be captured. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
no setter
mpiData → ThreeDSecureData?
Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
no setter
originalMerchantReference → String?
The original merchant reference to cancel.
no setter
originalReference → String
The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification
no setter
platformChargebackLogic → PlatformChargebackLogic?
Defines how to book chargebacks when using Adyen for Platforms.
no setter
reference → String?
Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
splits → BuiltList<Split>?
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for platforms.
no setter
tenderReference → String?
The transaction reference provided by the PED. For point-of-sale integrations only.
no setter
uniqueTerminalId → String?
Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(CaptureRequestBuilder)) → CaptureRequest
Rebuilds the instance.
inherited
toBuilder() → CaptureRequestBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

serializer → Serializer<CaptureRequest>
no setter