---
title: "Simulate Refund Completion/Cancellation"
method: PATCH
path: "/refund/simulate"
tags: ["Refund"]
---

# Simulate Refund Completion/Cancellation

`PATCH /refund/simulate`

## Request

- Base URL: `https://api.finmo.net/v1`
- URL: `https://api.finmo.net/v1/refund/simulate`
- Auth: HTTP basic

Use this Method in the sandbox to simulate the completion of a refund related to a payin/va-payin..

To complete the refund, the Payin must be in a ```PENDING``` status. Upon successful execution of this API, the refund status updates to ```COMPLETED```.

## Request body

- object
  - `refund_id` string, required: Refund reference (xo_*)

## Response `200`

OK

- object
  - `data` object
    - `amount` integer
    - `created_at` string, date-time
    - `currency` string
    - `customer_id` string, nullable
    - `debit_wallet_id` string
    - `debit_wallet_transaction_id` string
    - `description` string, nullable
    - `fees_currency` string
    - `fees_including_tax` number
    - `fees_wallet_id` string
    - `fees_wallet_transaction_id` string
    - `fees_without_tax` number
    - `is_fees_charged` boolean
    - `metadata` string, nullable
    - `org_id` string
    - `organization_reference_id` string
    - `payin_id` string
    - `payin_method_name` string
    - `receipt_email` string, nullable
    - `refund_id` string
    - `refunded_at` string, date-time
    - `status` string
    - `tax_on_fees` number
    - `transaction_id` string
    - `type` string
    - `updated_at` string, date-time
    - `webhook_url` string, uri, nullable
  - `request_id` string
  - `request_time` string, date-time
  - `status_code` integer
  - `status_text` string
  - `success` boolean

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `406`: Not Acceptable

## Changes

- **2026-11-03** `39e5e5ab5c3a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/finmo/apis/finmo-api/changes/refund/simulate/patch.md)

---

[API](https://skmtc.dev/finmo/apis/finmo-api.md) - [All operations](https://skmtc.dev/finmo/apis/finmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/finmo/apis/finmo-api/revisions/39e5e5ab5c3a?raw)
