Cancel Recurring charge (Vipps MobilePay)
vipps_cancel_chargeCancel a pending, due, reserved, or partially captured Recurring charge to release reserved funds back to the customer. Refuses other statuses; irreversible, so confirm each call.
Instructions
Cancel a pending, due, reserved or partially captured Recurring charge; money reserved and not captured is released to the customer. A pending, due or reserved charge ends as CANCELLED, a partially captured one as CHARGED. Reads the charge first and refuses any other status. The agreement itself is not changed. 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>",
"idempotencyKey": "<idempotencyKey>"
},
"name": "vipps_cancel_charge"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| chargeId | Yes | The Recurring charge id, e.g. chr-123ab. | |
| agreementId | Yes | The Recurring agreement id, e.g. agr_5kSeqz. | |
| 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. |