---
title: "Create a refund"
method: POST
path: "/api/v1/refunds"
tags: ["Payments"]
---

# Create a refund

`POST /api/v1/refunds`

## Request

- Base URL: `https://merchant.zahlo.eu`
- URL: `https://merchant.zahlo.eu/api/v1/refunds`
- Auth: API key in header `x-api-key`

Create a refund. Use the response status and request ID to decide whether to retry, reconcile, or ask the customer for action.

## Headers

- `Idempotency-Key` string

## Request body

- RefundCreateRequest
  - `paymentId` string, required
  - `amountMinor` integer
  - `reason` string
  - `metadata` object: Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

## Response `201`

Refund created

- Refund
  - `id` string, required
  - `object` 'refund', required
  - `livemode` boolean, required
  - `createdAt` string, date-time, required
  - `paymentId` string, required: The payment's id, as GET /api/v1/payments/{id} takes it.
  - `amountMinor` integer, required
  - `currency` string, required
  - `status` 'pending' | 'succeeded' | 'failed', required
  - `reason` string, nullable, required
  - `metadata` object, required: Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

## Other responses

- `400`: Invalid request
- `401`: Authentication failed
- `404`: Resource not found
- `409`: Request conflicts with existing state

---

[API](https://skmtc.dev/zahlo/apis/zahlo-merchant-api.md) - [All operations](https://skmtc.dev/zahlo/apis/zahlo-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zahlo/apis/zahlo-merchant-api/revisions/8fcbef981e0d?raw)
