Refund return
refund_returnRecords a refund for a return once money is sent back at the payment provider, applying it to the order's refunds and completing the received return.
Instructions
Record a refund for a return - money already sent back at the payment provider. It counts against the order's refunds and completes a received return.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"orderId": "<orderId>",
"returnId": "<returnId>",
"reference": "<reference>"
},
"name": "refund_return"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| amount | No | Minor units. Omit to refund the returned lines' value, capped at what is left refundable | |
| orderId | Yes | ||
| returnId | Yes | The return's id (get_order) | |
| reference | Yes | The payment provider's refund id; repeating it records nothing twice |