Reverse Transaction Transfer

Reverses a transaction transfer from another merchant within a marketplace

SecurityLimepay-Token
Request
path Parameters
transactionId
required
string
Request Body schema: application/json
fromMerchant
required
string

The source of the reversal. This must be a merchant that was previously transferred funds for this transaction.

toMerchant
required
string

The destination of the reversal. This must be the merchant who created the original transaction.

required
object (PaymentAmount)

The amount and currency of the order, unsurcharged, used if the checkout amount is the same for all payment types (ie paymentTypeAmounts is omitted)

reverseLevy
required
boolean

If true, the levy (fee) will be proportionally reversed for this transfer reversal

object (Map_V)
Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/transactions/{transactionId}/transfers:reverse
Request samples
application/json
{
  • "fromMerchant": "mcht_ZmpO3_Umx0WmN5ff",
  • "toMerchant": "mcht_ZmpO3_Umx0WmN5ff",
  • "reverseAmount": {
    },
  • "reverseLevy": true,
  • "metadata": {
    }
}
Response samples
application/json
{
  • "transactionTransferId": "trantransfer_ZmpO4fUmx0WmN5f1",
  • "transactionId": "tran_ZmpO3_Umx0WmN5fi",
  • "transactionMerchant": "mcht_ZmpO3_Umx0WmN5ff",
  • "transactionAmount": 0,
  • "currency": "AUD",
  • "totalTransferred": 0,
  • "totalSurcharged": 0,
  • "totalLevied": 0,
  • "transfers": [
    ]
}
Copyright © April Solutions 2023. All right reserved.