Transfer Transaction

Transfers a transaction to 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 transfer. This must also be the merchant that created the transaction.

toMerchant
required
string

The destination of the transfer

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)

surcharge
required
boolean

Indicates if the associated Limepay platform fees for the transaction should be surcharged to the toMerchant and credited back to the fromMerchant merchant

levy
integer <int64>

Optionally set this with an amount you want to be deducted from the merchant after the transfer. If surcharge is true, the levy will be added to the total fees deducted from toMerchant.

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