Refund full amount

Request

Send a refund request to return the full settled amount to your customer.

Note: No request body is needed for this request.

Security

BasicAuth

Path

linkDatastringrequired

Action link that's received in your request.

Content-Typestringrequired

Example:application/vnd.worldpay.payments-v7+json

Acceptstringrequired

Example:application/vnd.worldpay.payments-v7+json

Bodyapplication/vnd.worldpay.payments-v7+json

referencestring, [ 1 .. 128 ] characters^[-A-Za-z0-9]*$

An optional reference generated by you to identify a payment throughout its lifecycle.

Example:"refund-reference"

fastRefundobject

Allows you to request a faster refund.

{
  "reference": "refund-reference",
  "fastRefund": {
    "enabled": true,
    "fallbackToStandard": true
  }
}

Responses

The refund request has been accepted

Bodyapplication/vnd.worldpay.payments-v7+json

paymentIdstring, [ 21 .. 36 ] characters^[A-Za-z0-9_-]+$

Unique identifier generated by us for a single payment. Generated at authorization, and maintained through successive payment actions.

Example:"payI-dUcet9fk4_X4qZU0hpU0"

commandIdstring, [ 21 .. 36 ] characters^[A-Za-z0-9_-]+$

Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.

Example:"cmdRvD-OxCyXgJLQ9_jbqXAC0"

_linksobject

Response

Response to refund an authorization

{
  "paymentId": "payI-dUcet9fk4_X4qZU0hpU0",
  "commandId": "cmdwZ5y_rSV1VmjD6CpgCuXG0",
  "_links": {
    "cardPayments:events": {
      "href": "/payments/events/:linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}