Last Updated: 04 December 2024 | Change Log

Refund a payment

You can fully or partially refund a payment.

Fully refund a payment

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

POST to the payments:refund action link received in your complete settlement, partial settlement or sale response.

Full refund request

As this is a full refund, follow the action links from settle and partial settle.

POST https://try.access.worldpay.com/payments/settlements/refunds/full/eyJrIjoiazNhYjYzMiJ9

Note

No request body is needed for this request.

Full refund response

The response contains the payments:events action link. Use this resource to make an order inquiry.

{
    "_links": {
        "payments:events": {
            "href": "https://access.worldpay.com/payments/events/eyJrIjoiazNhYjYzMiJ9"
        },
        "curies": [
            {
                "name": "payments",
                "href": "https://access.worldpay.com/rels/payments/{rel}",
                "templated": true
            }
        ]
    }
}

Partially refund a payment

Send a partial refund request to return a portion of the settled amount to your customer.

POST your request to the payments:partialRefund action link returned in your settlement or sale response.

Partial refund request

Send the amount to refund and the authorization currency in the body.

POST https://try.access.worldpay.com/payments/settlements/refunds/partials/eyJrIjoiazNhYjYzMiJ9

{
    "value": {
        "amount": 125,
        "currency": "GBP"
    },
    "reference": "partial-refund-reference"
}

Partial refund response

The response contains the payments:events action link. Use this resource to make an order inquiry.

{
    "_links": {
        "payments:partialRefund": {
            "href": "https://try.access.worldpay.com/payments/settlements/refunds/partials/eyJrIjoiazNhYjYzMiJ9"
        },
        "payments:events": {
            "href": "https://try.access.worldpay.com/payments/events/eyJrIjoiazNhYjYzMiJ9"
        },
        "curies": [{
            "name": "payments",
            "href": "https://try.access.worldpay.com/rels/payments/{rel}",
            "templated": true
        }]
    }
}

Next steps


Query a payment