POST /cancel

Default value: "application/json"

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.

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.

Your description for the split item.

The amount of the split item.

• Required for all split types in the Classic Platforms integration.
• Required if type is BalanceAccount, Commission, Default, or VAT in your Balance Platform integration.

The value of the split amount, in minor units.

The three-character ISO currency code. By default, this is the original payment currency.

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.
• 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.
• Commission: your platform's commission (specified in amount) on the payment, booked to your 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.

Possible values:

• "MarketPlace"
• "SchemeFee"
• "Surcharge"
• "Commission"
• "PaymentFee"
• "AdyenCommission"
• "Tip"
• "AdyenMarkup"
• "Remainder"
• "Interchange"
• "AcquiringFees"
• "AdyenFees"
• "BalanceAccount"
• "Default"
• "VAT"

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.

Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.

The original pspReference of the payment to modify. This reference is returned in:

• authorisation response
• authorisation notification

The transaction reference provided by the PED. For point-of-sale integrations only.

The merchant account that is used to process the payment.

Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).

Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.

The electronic commerce indicator.

The CAVV algorithm used. Include this only for 3D Secure 1.

In 3D Secure 1, the authentication response if the shopper was redirected.

In 3D Secure 2, this is the transStatus from the challenge result. If the transaction was frictionless, omit this parameter.

Possible values:

• "A"
• "N"
• "Y"
• "U"

In 3D Secure 1, this is the enrollment response from the 3D directory server.

In 3D Secure 2, this is the transStatus from the ARes.

Possible values:

• "D"
• "C"
• "R"
• "A"
• "N"
• "I"
• "Y"
• "U"

The version of the 3D Secure protocol.

Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to 3D Secure API reference.

Possible values:

• "07"
• "06"
• "05"
• "04"
• "03"
• "02"
• "01"

Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.

Network token authentication verification value (TAVV). The network token cryptogram.

Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).

Provides information on why the transStatus field has the specified value. For possible values, refer to our docs.

The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).

The original merchant reference to cancel.

Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.

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.

Defines how to book chargebacks when using Adyen for Platforms.

The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account.

The unique identifier of the balance account against which the disputed amount is booked.

Required if behavior is deductFromOneBalanceAccount.

The method of handling the chargeback.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.

Possible values:

• "deductAccordingToSplitRatio"
• "deductFromOneBalanceAccount"
• "deductFromLiableAccount"