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 that needs reversing
reverseLevy required	boolean If `true`, the levy (fee) will be proportionally reversed for this transfer reversal
	object (Map_V) This can be used to associate any metadata to this transfer reversal. 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:reverse

Request samples

Payload
Curl
JavaScript

application/json

{"fromMerchant": "mcht_Z2idOPj2ECYkyM6G",
"toMerchant": "mcht_Z2idOPj2ECYkyM6G",
"reverseAmount": {"amount": 0,
"currency": "AUD"
},
"reverseLevy": true,
"metadata": {"property1": "string",
"property2": "string"
}
}

Response samples

application/json

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