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 that needs transferring
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) This can be used to associate any metadata to this transfer. Must be specified as key-value pairs (JSON object).

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/transactions/{transactionId}/transfers

Request samples

Payload
Curl
JavaScript

application/json

{"fromMerchant": "mcht_Zz5Fx_z_YQaAoSHU",
"toMerchant": "mcht_Zz5Fx_z_YQaAoSHU",
"transferAmount": {"amount": 0,
"currency": "AUD"
},
"surcharge": true,
"levy": 0,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

application/json

{"transactionTransferId": "trantransfer_Zz5Fyfz_YQaAoSHr",
"transactionId": "tran_Zz5FyPz_YQaAoSHX",
"transactionMerchant": "mcht_Zz5Fx_z_YQaAoSHU",
"transactionAmount": 0,
"currency": "AUD",
"totalTransferred": 0,
"totalSurcharged": 0,
"totalLevied": 0,
"transfers": [{"transferredToMerchantId": "mcht_Zz5Fx_z_YQaAoSHU",
"idempotencyKey": "string",
"createdAt": "2019-08-24T14:15:22Z",
"transferred": 0,
"surcharged": 0,
"levy": 0,
"metadata": { }
}
]
}