PaymentRefundRequest class abstract

PaymentRefundRequest

Properties:

  • amount - The amount that you want to refund. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
  • applicationInfo - Information about your application. For more details, see Building Adyen solutions.
  • capturePspReference - This is only available for PayPal refunds. The pspReference of the specific capture to refund.
  • enhancedSchemeData - Enhanced scheme data that may be required for processing the payment. For example, airline information.
  • lineItems - Price and product information of the refunded items, required for partial refunds. > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.
  • merchantAccount - The merchant account that is used to process the payment.
  • merchantRefundReason - The reason for the refund request. Possible values: * FRAUD * CUSTOMER REQUEST * RETURN * DUPLICATE * OTHER
  • reference - Your reference for the refund request. 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 process payments for marketplaces or platforms.
  • store - The online store or physical store that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails.
Annotations
  • @BuiltValue.new()

Constructors

PaymentRefundRequest([void updates(PaymentRefundRequestBuilder b)])
factory

Properties

amount → Amount
The amount that you want to refund. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.
no setter
applicationInfo → ApplicationInfo?
Information about your application. For more details, see Building Adyen solutions.
no setter
capturePspReference → String?
This is only available for PayPal refunds. The pspReference of the specific capture to refund.
no setter
enhancedSchemeData → EnhancedSchemeData?
Enhanced scheme data that may be required for processing the payment. For example, airline information.
no setter
hashCode → int
The hash code for this object.
no setterinherited
lineItems → BuiltList<LineItem>?
Price and product information of the refunded items, required for partial refunds. > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.
no setter
merchantAccount → String
The merchant account that is used to process the payment.
no setter
merchantRefundReason → PaymentRefundRequestMerchantRefundReasonEnum?
The reason for the refund request. Possible values: * FRAUD * CUSTOMER REQUEST * RETURN * DUPLICATE * OTHER
no setter
reference → String?
Your reference for the refund request. 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 process payments for marketplaces or platforms.
no setter
store → String?
The online store or physical store that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PaymentRefundRequestBuilder)) → PaymentRefundRequest
Rebuilds the instance.
inherited
toBuilder() → PaymentRefundRequestBuilder
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<PaymentRefundRequest>
no setter