Body

• additionalData object

  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. For more information on possible key-value pairs, refer to the ModificationRequest.additionalData section.

• merchantAccount string Required

  The merchant account that is used to process the payment.

• modificationAmount object

  The amount that needs to be captured/refunded. Required for /capture and /refund, not allowed for /cancel. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.

  Hide modificationAmount attributes Show modificationAmount attributes

  • currency string Required

    The three-character ISO currency code.

    Minimum length is 3, maximum length is 3.

  • value integer(int64) Required

    The payable amount that can be charged for the transaction.

    The transaction amount needs to be represented in minor units according to the following table.

• originalMerchantReference string

  The original merchant reference to cancel.

• originalReference string Required

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

  • authorisation response
  • authorisation notification
• reference string

  Optionally, you can specify your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.

• splits array[object]

  The details of how the payment should be split when distributing a payment to a Marketpay Marketplace and its Accounts.

  Hide splits attributes Show splits attributes

  • account string

    The account to which this split applies.

    Required if the type is MarketPlace.

  • amount object Required

    The amount of this split.

    Hide amount attributes Show amount attributes

    • currency string

      The three-character ISO currency code.

      If this value is not provided, the currency in which the payment is made will be used.

      Minimum length is 3, maximum length is 3.

    • value integer(int64) Required

      The payable amount that can be charged for the transaction.

      The transaction amount needs to be represented in minor units according to the following table.

  • description string

    A description of this split.

  • reference string

    The reference of this split. Used to link other operations (e.g. captures and refunds) to this split.

    Required if the type is MarketPlace.

  • type string Required

    The type of this split.

    Permitted values: Default, PaymentFee, VAT, Commission, MarketPlace, Verification.

    Values are Commission, Default, MarketPlace, PaymentFee, VAT, or Verification.

• tenderReference string

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

• uniqueTerminalId string

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