payments_refund
Request a refund for a payment by providing payment ID and amount in minor units. Returns a structured confirmation after validation.
Instructions
Request a refund for a payment. Validates payment_id, amount (positive integer minor units), optional reason and currency. Returns a structured confirmation (stub).
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": {
"payment_id": "<payment_id>",
"amount": "<amount>"
},
"name": "payments_refund"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payment_id | Yes | ID of the payment to refund | |
| amount | Yes | Refund amount in minor units (e.g. cents) | |
| reason | No | Optional reason for the refund | |
| currency | No | ISO 4217 currency code (default: BRL) | BRL |