Submit a payment refund request

Request

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

Note: No request body is needed for this request.

Security

BasicAuth

Path

linkDatastringrequired

WP-Api-Versionstringrequired

The API version

Value:"2024-06-01"

Example:2024-06-01

curl -i -X POST \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/api/payments/{linkData}/refunds' \
  -H 'WP-Api-Version: 2024-06-01'

Responses

Accepted

Bodyapplication/json

outcomestring

Value:"sentForRefund"

paymentIdstring^[A-Za-z0-9_-]+$

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

_linksobject

Return details about the status of the payment.

Response

{
  "outcome": "sentForRefund",
  "paymentId": "payI-dUcet9fk4_X4qZU0hpU0",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0md%2BbPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y%3A7njc4649JSrU7%2BvFDl1J36%2BcwOkX0lW4Z%2BfnZKMutoUGX3m1%3Amp3aEvr3BYtH3ZBei61fRGtglovAih6FUXj2880UCtZGZ21djyVQzY36sEFMZMvXsW6eOLVNOsPL6ecsn3Dp377s7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQ6i4R8ak4j6oWbsrX5AP4ErD6p2VzRF0yzljcK%2BKWD8%2BEEBcQpn0%3ADcXCJRXfVD0ibZ%3AVhRHFzbbwymcuTiRbNw%3D"
    }
  }
}