---
title: "Create Refund"
method: POST
path: "/api/refund/{portone_order_ref}"
tags: ["Refund APIs"]
---

# Create Refund

`POST /api/refund/{portone_order_ref}`

Create Refund for the transaction created on PortOne. Merchant can either create the full or partial refund. Few PSPs do not support refunds or partial refunds. Please refer PortOne docs for additional information. The response body contains the amount to refund and the array of all refunds performed.

## Path parameters

- `portone_order_ref` string, required

## Headers

- `X-Portone-Client-Key` string
- `Authorization` string

## Request body

- object
  - `amount` number, double, required — The amount you want to refund (ignored if a refund of type 'full' is requested)
  - `channel` string, required — The payment channel key used to make the payment for the transaction
  - `description` string, required — The description for the refund
  - `environment` 'live' | 'sandbox', required — The environment of the transaction is either live OR sandbox
  - `refund_type` 'full' | 'partial', required — The type of the refund indicates whether a full or partial refund is being requested. If the refund type is 'full', the 'amount' field is ignored
  - `refund_reason` string, required — The reason for the refund

## Response `200`

Successful response

- object
  - `refundDetails` RefundContent[] — The array of Refund details
    - `refund_date` string — The date of the refund.
    - `refund_id` string — The unique reference of the refund request created by PortOne.
    - `psp_refund_id` string — The unique reference of the refund request created by PSP.
    - `amount` number, double — The amount of refund.
    - `currency` string — The currency of the refund/ transaction.
    - `refund_status` string — The status of the refund. Refer PortOne docs for additional details.
    - `refund_type` string — The type of the refund. Either partial/full. Refer PortOne docs for additional details.
    - `refund_reason` string — The reason of the refund request.
  - `amountToRefund` number, double — The amount remaining to refund

## Other responses

- `400` — Failure response
- `401` — Failure response

---

[API](https://skmtc.dev/portone/apis/payment-apis.md) · [All operations](https://skmtc.dev/portone/apis/payment-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/portone/payment-apis/revisions/f3ccea652555/schema)
