---
title: "Update the refund retention rate for a merchant"
method: PUT
path: "/api/v1/merchants/{id}/refund-retention-rate"
tags: ["Merchants"]
---

# Update the refund retention rate for a merchant

`PUT /api/v1/merchants/{id}/refund-retention-rate`

## Request

- Base URL: `https://core.quidkey.com`
- URL: `https://core.quidkey.com/api/v1/merchants/{id}/refund-retention-rate`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/banqzinc/apis/quidkey-api/docs/api/v1/merchants/:id/refund-retention-rate/put.ts> (a function with typed inputs; its response is checked against the schema)

Update the refund retention rate for a merchant

## Path parameters

- `id` string, uuid, required: The unique identifier of the merchant

## Request body

- MerchantRefundRetentionRateUpdate: Input for updating the merchant refund retention rate
  - `refund_retention_rate` string, required: The refund retention rate as a decimal string between 0 and 1 (e.g. "0.05" for 5%)

## Response `200`

Success

- MerchantResponse
  - `success` boolean, required: Indicates if the request was successful
  - `data` object, required: Merchant information
    - `id` string, uuid, required: The unique identifier of the merchant
    - `brand_name` string, required: The brand name of the merchant
    - `uri` string, uri, required: The URI of the merchant's website
    - `category_code` string, required: The merchant category code
    - `activation_status` union, required: The activation status of the merchant
      - 'active'
      - 'inactive'
    - `mode` union, required: The mode of the merchant
      - 'sandbox'
      - 'live'
    - `country` string: The country of the merchant
    - `settlement_currency` string, nullable: The merchant's effective billing/settlement currency, derived from their settlement bank account (with a country fallback). Null when it can't be resolved. Populated by GET /merchants/:id only; absent from list responses.
    - `multi_account_setting` boolean, required: The multi-account setting of the merchant
    - `refund_retention_rate` string, nullable, required: The refund retention rate as a decimal (e.g. "0.0500" for 5%)
    - `client_id` string, required: The client ID of the merchant
    - `has_client_secret` boolean, required: Whether a client secret is set for this merchant
    - `account_owners` object[]: The account owners associated with this merchant
      - `id` string, uuid, required: The unique identifier of the account owner
      - `full_name` string, required: The full name of the account owner
      - `email` string, email, required: The email address of the account owner
      - `phone_number` string: The phone number in format: country_code;number (e.g., 44;7395236209)
      - `role` string: The role of the account owner within the organization
      - `is_primary` boolean, required: Whether this account owner is the primary contact
      - `created_at` string, date-time, required: The timestamp when the account owner was created
      - `updated_at` string, date-time, required: The timestamp when the account owner was last updated

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found

## Changes

- **2026-06-17** `b372e7d5563d`: 1 info
  - endpoint added
- **2025-11-02** `919eb7a392aa`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/banqzinc/apis/quidkey-api/changes/api/v1/merchants/:id/refund-retention-rate/put.md)

---

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