Access Worldpay
/
Settle or cancel an authorization

Last Updated: 04 December 2024 | Change Log

Settle or cancel an authorization

After you receive a successful authorization you can:

  • Settle the authorization to receive all the funds from your customer and complete the payment.

  • Partially settle the authorization to receive a portion of the funds from your customer and partially complete the payment.

  • Cancel the authorization to remove the fund reservation from your customer account.


Settle an authorization

To receive all the funds from the customer send us a settle request.

POST to the payments:settle action link received in any of the authorization responses to settle an authorization.

Settle request

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

Note

No request body is needed for this request.

When you make your settle request, the payment event changes to sentForSettlement.

Note

A successful settle request does not mean that the payment will be settled, this is at the discretion of the card acquirer.

Settle response

In your response you get links to, refund, partial refund or query an authorization.

{
    "_links": {
        "payments:refund": {
            "href": "https://try.access.worldpay.com/payments/settlements/refunds/full/eyJrIjoiazNhYjYzMiJ9"
        },
        "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
            }
        ]
    }
}

Partially settle an authorization

To receive a portion of the funds from the customer send us a partial settle request.

POST your partial settlement request to the payments:partialRefund action link you received in your authorization response. Specify the amount and the required settlement currency in the body.

Note

We do not validate that the currency and amount is the same as that of the original payment.

Partially settle request

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

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

Descriptions of your partial settlement request parameters:

ParameterRequiredDescription
reference✅A unique reference generated by you used to identify the partial settlement. For more information and best practice see transaction reference format.

Partially settle response

In the response, you get links to refund, partial refund or query the payment.

{
    "_links": {
        "payments:refund": {
            "href": "https://try.access.worldpay.com/payments/settlements/refunds/full/eyJrIjoiazNhYjYzMiJ9"
        },
        "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
            }
        ]
    }
}

Cancel an authorization

If you don’t want to proceed with payment send us a cancel request.

POST to the payments:cancel action link returned in any of your authorization responses to cancel the authorization.

Note

You can only cancel an authorization which has been authorized, if an authorization has been settled then you need to create a refund.

Request

POST https://try.access.worldpay.com/payments/authorizations/cancellations/eyJrIjoiazNhYjYzMiJ9

Note

No request body is needed for this request.

Response

In the response you get links allowing you to query the payment.

{
    "_links": {
        "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

Refund a payment

Query a payment