---
title: "Trigger a refund for a specific payment."
method: POST
path: "/finance/v1/folios/{folioId}/payments/{paymentId}/refunds"
tags: ["FolioPayments"]
---

# Trigger a refund for a specific payment.

`POST /finance/v1/folios/{folioId}/payments/{paymentId}/refunds`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/finance/v1/folios/{folioId}/payments/{paymentId}/refunds`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `folios.manage`, `admin`

Trigger a refund for a specific payment on this folio. The refund will be processed asynchronously. Use the location header to poll for
the status of the refund. As long as a refund is pending the allowed refund amount for this payment will be reduced by the amount. The refund
times out after 10 minutes automatically<br>You must have this scope: 'folios.manage'.<br>For fine-grained clients, you must have this permission: 'core.folio_refunds.create'.

## Path parameters

- `folioId` string, required
- `paymentId` string, required

## Headers

- `Idempotency-Key` string

## Request body

- CreatePaymentRefundRequest
  - `amount` MonetaryValueModel, required
    - `amount` number, double, required
    - `currency` string, required
  - `businessDate` string, date, nullable: The business date of the refund. Defaults to the current date. In some cases you might want to post the refunds to the previous business date, this is only possible until 6 AM of the current day.
  - `reason` string, nullable: The reason for payment refund

## Response `201`

Refund was created and will be processed.

- RefundCreatedModel
  - `id` string, required

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `415`: Unsupported media type.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-finance-api.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-finance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-finance-api/revisions/6f1d524c1ea7?raw)