POST /settlements/reverseTransfer/{reverseTransferBy}/{reverseTransferIds}
Reverses a settlement for the provided transfer id values
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| request |
|
context
|
|
HttpServletRequest
|
| reverseTransferBy |
Specifies what id values are being provided. Valid values are: [order, movement, or settlement]. |
path
|
|
String
|
| reverseTransferIds |
Single or comma separated list of order, movement or settlement id to reverse a transferred settlement. |
path
|
|
String
|
Result
Response
of type:
application/xml
application/json
application/pdf
a response object containing the transferred records and any exceptions generated from the transfer process.
For example, /settlements/reverseTransfer/order/3000546,3000547,3000548
would un-transfer orders 3000546, 3000547 and 3000548 and return a response with information about transferred records and exception details.
Try It Out
Request