Refund Recurring charge (Vipps MobilePay)
vipps_refund_chargeRefund all or part of a charged Recurring payment to a customer. Validates the charge amount and currency before sending the refund to Vipps MobilePay; refunds cannot be undone.
Instructions
Refund all or part of a charged Recurring charge to the customer. Reads the charge first and refuses, without sending anything, when the currency differs or the amount is more than is charged and not yet refunded. The description is sent to Vipps MobilePay and is not logged. Moves or releases money and cannot be undone. Disabled by default (VIPPS_ENABLE_WRITES, or the gateway host policy enableWrites); a person should confirm every call.
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": {
"agreementId": "<agreementId>",
"chargeId": "<chargeId>",
"amount": "<amount>",
"currency": "<currency>",
"description": "<description>",
"idempotencyKey": "<idempotencyKey>"
},
"name": "vipps_refund_charge"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | Yes | Amount in minor units (øre, cent): 125.50 kr is 12550. | |
| chargeId | Yes | The Recurring charge id, e.g. chr-123ab. | |
| currency | Yes | ISO 4217 currency code of the payment. | |
| agreementId | Yes | The Recurring agreement id, e.g. agr_5kSeqz. | |
| description | Yes | Why the charge is refunded (1-100 characters), as Vipps MobilePay requires. | |
| idempotencyKey | Yes | Required operation key (8-40 letters, digits or dashes), sent as Idempotency-Key. Choose a new one for each new change, record it before the call, and send the same key when repeating that change after a failure or a lost answer: Vipps MobilePay then carries it out only once. |