---
title: "Issue a refund"
method: POST
path: "/refunds"
---

# Issue a refund

`POST /refunds`

## Request

- Base URL: `https://gateway.pmnts-sandbox.io/v1.0`
- URL: `https://gateway.pmnts-sandbox.io/v1.0/refunds`
- Auth: HTTP basic

Issue a refund against a purchase or standalone

## Request body

- object
  - `amount` integer, required: A positive integer representing how much to refund, in the smallest currency unit (e.g. 100 to charge $1.00, or 100 to Charge ¥100, a zero decimal currency).
  - `reference` string, required: Merchant's reference for the refund. Must be unique per refund. Max length 255 characters.
  - `transaction_id` string: ID of the original transaction to be refunded (XXX-P-YYYYYY). Required for an associated refund.
  - `card_token` string: Token of the card being refunded. Required unless transaction_id or card details are provided.
  - `card_number` string: Number of the card being refunded. Required unless transaction_id or card_token are provided.
  - `card_expiry` string: Expiry of the card being refunded. Required unless transaction_id or card_token are provided.
  - `card_holder` string: Name on the card being refunded. Required unless transaction_id or card_token are provided.
  - `description` string: Description for the refund.
  - `currency` string: Currency being refunded. Ignored if transaction_id is present.
  - `descriptor` string: Deprecated — use extra.descriptor instead. Description that appears on the customer's statement.
  - `extra` object: Extended fields, only accepted for merchants configured to support them. See the Extra and Extended Fields guide.
    - `xid` string: 3D Secure transaction ID from your MPI.
    - `cavv` string: 3D Secure CAVV, Base64 encoded.
    - `sli` string: Security Level Indicator for the cardholder authentication used.
    - `par` string: The PARes value from 3D Secure.
    - `ver` string: The VERes value from 3D Secure.
    - `ecm` string: Electronic Commerce Indicator.
    - `threeds_version` string: 3DS version used for authenticating the card, e.g. 2, 2.1, 2.1.0. Defaults to 1 if omitted.
    - `directory_server_txn_id` string: Directory Server Transaction ID from the 3D Secure provider, commonly a UUID.
    - `sca_exemption` string: SCA exemption code applied to this transaction.
    - `card_on_file` boolean: Marks this transaction as a stored-credential/card-on-file transaction.
    - `transaction_initiated_by` string: Who initiated the transaction, e.g. merchant or cardholder.
    - `stored_credential_indicator` string: Indicates how the stored credential is being used for this transaction.
    - `name` string: Sub-merchant name, only accepted for merchants configured as a payment aggregator. See Payment Aggregators.
    - `location` string: Sub-merchant location, only accepted for merchants configured as a payment aggregator.
    - `descriptor` object: Dynamic descriptor fields shown on the cardholder's statement. See Dynamic Descriptors.
    - `sub_merchant` object: Sub-merchant details, only accepted for merchants configured as a payment aggregator.
  - `metadata` object: Metadata for the refund.

## Response `200`

200

- object
  - `successful` boolean
  - `response` object
    - `authorization` string
    - `id` string: The refund's ID (XXX-R-YYYYYY)
    - `amount` integer
    - `refunded` string
    - `message` string
    - `card_holder` string
    - `card_number` string
    - `card_expiry` string
    - `card_type` string
    - `transaction_id` string: The refund's ID. Alias of id. This is not the original purchase's ID.
    - `reference` string
    - `currency` string
    - `successful` boolean
    - `transaction_date` string
    - `response_code` string
    - `settlement_date` string
    - `metadata` object
    - `standalone` boolean
    - `rrn` string
  - `errors` unknown[]
    - unknown
  - `test` boolean

## Changes

- **2026-11-03** `a62ddbae3800`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fatzebra/apis/gateway/changes/refunds/post.md)

---

[API](https://skmtc.dev/fatzebra/apis/gateway.md) - [All operations](https://skmtc.dev/fatzebra/apis/gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/fatzebra/apis/gateway/revisions/a62ddbae3800?raw)