Adjust payment Copy section link Copied!

You can adjust the split of a payment independently of the payment method used for the transaction. It depends on the transaction status.

If you want to adjust the amount of the payment, it will also depend on the payment method used for the transaction.

You can only adjust payment operations, not other operations such as a payout or a refund.

Please refer to the payment flows to understand when this operation is valid.

Adjusting only the split of a payment Copy section link Copied!

You can adjust the split of a transaction if it meets the following criteria:

  • The transaction status must be completed.
  • If the payment breakdown already occurred, the operation status must be registered.
  • If it didn't, the operation status must be waiting, cashed or registered.

If you want to adjust only the split and not the amount, the payment amount must be identical to the original one.

Adjusting both payment amount and split Copy section link Copied!

You can't adjust the payment amount of a transaction if the payment method used for the transaction was a card or a SDD payment.

To adjust both the payment amount and the split, it must meet the criteria listed in the previous section.

A new breakdown must be provided in the adjustPayment request for the new amount.

Refer to the Payin operations life cycle section of the Payment flow to get the list of statuses and scenarios.

Adjust a payment Copy section link Copied!

From your server, make a /payin/adjustPayment request with the following parameters:

Parameter Name
Required
Type
Description
breakdownList
array
List of breakdown
metaData
object
JSON data for the marketplace. This data is not used by payment systems.
adjustAmount
object
Mandatory if the amount is different than the initial payment.
orderId
check
string
Order id obtained in order creation
transactionId
string
Id of the payment transaction.

Example: Copy section link Copied!

Here is an example of a JSON payload for a/payin/adjustPayment request:

JSON
Copy
Copied
{
"orderId": "1354657",
"adjustAmount": {
"value": "100",
"currency": "EUR"
},
"breakdownList": [
{
"label": "bdl1",
"transactionRef": "ref1",
"sellerAccountNumber": "1300600000EUR01006110",
"amount": {
"value": "35",
"currency": "EUR"
}
},
{
"label": "bdl2",
"transactionRef": "ref2",
"sellerAccountNumber": "1300600000EUR01007110",
"amount": {
"value": "65",
"currency": "EUR"
}
}
]
}
Copy
Copied

Retrieving the result Copy section link Copied!

In response to your request, you will receive an adjustPaymentResponse object:

Parameter Name
Type
Description
resultCode
string
resultCodeMessage
string

Example: Copy section link Copied!

A successful payload response to the /payin/adjustPayment request will be:

JSON
Copy
Copied
{
"resultCode": "0"
}
Copy
Copied

If you encounter any error, you can check the following pages for troubleshooting: