Split class abstract

Split

Properties:

  • account - The unique identifier of the account to which the split amount is booked. Required if type is MarketPlace or BalanceAccount. * Classic Platforms integration: The accountCode of the account to which the split amount is booked. * Balance Platform: The balanceAccountId of the account to which the split amount is booked.
  • amount - The amount of the split item. * Required for all split types in the Classic Platforms integration. * Required if type is BalanceAccount, Commission, Surcharge, Default, or VAT in your Balance Platform integration.
  • description - Your description for the split item.
  • reference - Your unique reference for the part of the payment booked to the specified account. This is required if type is MarketPlace (Classic Platforms integration) or BalanceAccount (Balance Platform). For the other types, we also recommend providing a unique reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.
  • type - The part of the payment you want to book to the specified account. Possible values for the Balance Platform: * BalanceAccount: Books part of the payment (specified in amount) to the specified account. * Transaction fees types that you can book to the specified account: * AcquiringFees: The aggregated amount of the interchange and scheme fees. * PaymentFee: The aggregated amount of all transaction fees. * AdyenFees: The aggregated amount of Adyen's commission and markup fees. * AdyenCommission: The transaction fees due to Adyen under blended rates. * AdyenMarkup: The transaction fees due to Adyen under Interchange ++ pricing. * Interchange: The fees paid to the issuer for each payment made with the card network. * SchemeFee: The fees paid to the card scheme for using their network. * Commission: Your platform's commission on the payment (specified in amount), booked to your liable balance account. * Remainder: The amount left over after a currency conversion, booked to the specified account. * Surcharge: The payment acceptance fee imposed by the card scheme or debit network provider, paid by your user's customer. * TopUp: Allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. * VAT: The value-added tax charged on the payment, booked to your platforms liable balance account. * Default: In very specific use cases, allows you to book the specified amount to the specified account. For more information, contact Adyen support. Possible values for the Classic Platforms integration: Commission, Default, MarketPlace, PaymentFee, VAT.
Annotations
  • @BuiltValue.new()

Constructors

Split([void updates(SplitBuilder b)])
factory

Properties

account → String?
The unique identifier of the account to which the split amount is booked. Required if type is MarketPlace or BalanceAccount. * Classic Platforms integration: The accountCode of the account to which the split amount is booked. * Balance Platform: The balanceAccountId of the account to which the split amount is booked.
no setter
amount → SplitAmount?
The amount of the split item. * Required for all split types in the Classic Platforms integration. * Required if type is BalanceAccount, Commission, Surcharge, Default, or VAT in your Balance Platform integration.
no setter
description → String?
Your description for the split item.
no setter
hashCode → int
The hash code for this object.
no setterinherited
reference → String?
Your unique reference for the part of the payment booked to the specified account. This is required if type is MarketPlace (Classic Platforms integration) or BalanceAccount (Balance Platform). For the other types, we also recommend providing a unique reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → SplitTypeEnum
The part of the payment you want to book to the specified account. Possible values for the Balance Platform: * BalanceAccount: Books part of the payment (specified in amount) to the specified account. * Transaction fees types that you can book to the specified account: * AcquiringFees: The aggregated amount of the interchange and scheme fees. * PaymentFee: The aggregated amount of all transaction fees. * AdyenFees: The aggregated amount of Adyen's commission and markup fees. * AdyenCommission: The transaction fees due to Adyen under blended rates. * AdyenMarkup: The transaction fees due to Adyen under Interchange ++ pricing. * Interchange: The fees paid to the issuer for each payment made with the card network. * SchemeFee: The fees paid to the card scheme for using their network. * Commission: Your platform's commission on the payment (specified in amount), booked to your liable balance account. * Remainder: The amount left over after a currency conversion, booked to the specified account. * Surcharge: The payment acceptance fee imposed by the card scheme or debit network provider, paid by your user's customer. * TopUp: Allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. * VAT: The value-added tax charged on the payment, booked to your platforms liable balance account. * Default: In very specific use cases, allows you to book the specified amount to the specified account. For more information, contact Adyen support. Possible values for the Classic Platforms integration: Commission, Default, MarketPlace, PaymentFee, VAT.
no setter

Methods

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