# Refund partial amount

Send a partial refund request to return a portion of the settled amount to your customer. 
 Send the amount to refund and the authorization currency in the body.

Endpoint: POST /payments/settlements/refunds/partials/{linkData}
Version: 7
Security: BasicAuth

## Path parameters:

  - `linkData` (string, required)
    Action link that's received in your request.

## Header parameters:

  - `Content-Type` (string, required)
    Example: "application/vnd.worldpay.payments-v7+json"

  - `Accept` (string, required)
    Example: "application/vnd.worldpay.payments-v7+json"

## Request fields (application/vnd.worldpay.payments-v7+json):

  - `reference` (string, required)
    A reference generated by you to identify a payment throughout its lifecycle.
    Example: "partial-refund-reference"

  - `value` (object, required)
    An object that contains information about the value of the payment.

  - `value.amount` (integer, required)
    The payment amount. This is a whole number with an exponent e.g. if exponent is two, 250 is 2.50.
    Example: 250

  - `value.currency` (string, required)
    The three character currency code. See list of [supported currencies](/products/reference/supported-countries-currencies#iso-currency-codes).
    Example: "USD"

  - `value.surchargeAmount` (integer)
    The charging amount representing processing and service fees of the original transaction. {% admonition type="info" name="Note" %} The surcharge fee is included in the partial refund amount, e.g. if the value.surchargeAmount was $20 and the value.amount was $100, then the actual cost of goods/services was $80. {% /admonition %}

  - `value.convenienceAmount` (integer)
    The charging amount representing the offer of a convenient payment method or channel (such as online booking fee) of the original transaction. {% admonition type="info" name="Note" %} Convenience fee is included in the partial refund amount, e.g. if the value.convenienceAmount was $20 and the value.amount was $100, then the actual cost of goods/services was $80. {% /admonition %}

  - `merchant` (object)
    Contains information about the merchant.

  - `merchant.marketplace` (object)
    Supply additional data for marketplace use cases.

  - `merchant.marketplace.splitFundingReference` (string)
    A reference that you can use to split acquiring funding into your secondary bank account. Available for marketplaces and other merchant types. Not available for North America or Latin America payments. Contact your Implementation Manager to enable.

  - `fastRefund` (object)
    Allows you to request a faster refund.

  - `fastRefund.enabled` (boolean, required)
    Set to true to request fast refund.

  - `fastRefund.fallbackToStandard` (boolean)
    Request to fall back to standard refund processing in case the fast refund fails. Must be present if fast refund is set to true.

## Response 202 fields (application/vnd.worldpay.payments-v7+json):

  - `paymentId` (string)
    Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.
    Example: "payI-dUcet9fk4_X4qZU0hpU0"

  - `commandId` (string)
    Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.
    Example: "cmdRvD-OxCyXgJLQ9_jbqXAC0"

  - `_links` (object)

  - `_links.cardPayments:partialRefund` (object)
    An action link to refund a portion of the settled amount.

  - `_links.cardPayments:partialRefund.href` (string)
    An action link to refund a portion of the settled amount.
    Example: "https://try.access.worldpay-bsh.securedataplatform.com/payments/settlements/refunds/partials/{linkData}"

  - `_links.cardPayments:events` (object)
    An action link to retrieve the last event of the payment.

  - `_links.cardPayments:events.href` (string)
    An action link to retrieve the last event of the payment.
    Example: "https://try.access.worldpay-bsh.securedataplatform.com/payments/events/{linkData}"

## Response 400 fields (application/vnd.worldpay.payments-v7+json):

  - `errorName` (string)

  - `message` (string)

  - `validationErrors` (array)
    Further error details

  - `validationErrors.jsonPath` (string)

## Response 401 fields (application/vnd.worldpay.payments-v7+json):

  - `errorName` (string)

  - `message` (string)

## Response 404 fields (application/vnd.worldpay.payments-v7+json):

  - `errorName` (string)

  - `message` (string)

## Response 415 fields (application/vnd.worldpay.payments-v7+json):

  - `errorName` (string)

  - `message` (string)

## Response 500 fields (application/vnd.worldpay.payments-v7+json):

  - `errorName` (string)

  - `message` (string)