New service | Last updated: 01 July 2025

Manage your payment

Settle the payment

Partially or fully settle your payment through our Card Payments API using the next action link received in your original authorization response.

Settle an authorization

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

You can only do this if you set "requestAutoSettlement" to false in your payment initial request.

POST to the cardPayments:settle action link, returned in the authorization response, 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.

Settle response

In the response you get a 202 HTTP code which confirms we have received your request. The request has not processed at this stage.

{
  "paymentId": "pay7TLP6nGrpumEKxy7NiuOx0",
  "commandId": "cmdp9D1t-ENYQxVnJkh0YPRC0",
  "_links": {
    "cardPayments:refund": {
      "href": "/payments/settlements/refunds/full/:linkData"
    },
    "cardPayments:partialRefund": {
      "href": "/payments/settlements/refunds/partials/:linkData"
    },
    "cardPayments:reverse": {
      "href": "/payments/authorizations/reversals/:linkData"
    },
    "cardPayments:events": {
      "href": "/payments/events/:linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}

Confirm your settlement

To complete your settlement you must confirm it through our Split Payments endpoint. This allows you to independently settle lineItems.

Request

Fulfill all or some of the order items of the purchase.

Typical use case: The original purchase amount is £30 made up of:

item 1: £10 Socks from retailer 1
item 2: £20 Sandals from retailer 2

All items are ready to be shipped. You fulfill the whole purchase.

To initiate full settlement of the purchase, send us a settle request for the whole basket.

POST https://try.access.worldpay.com/splitPayments/{splitPaymentId}/fulfillments

Example request:

{
  "reference": "5D262CB9-57F2-4176-AA7C-B76A79284276",
  "description": "optional description of fulfillment",
  "paymentCommandId": "cmdJxsTja3Daad6dig338w2R0",
  "transactionType": "settle"
}

Response

Example

• 201 Merchant Pay-in accepted

{
  "fulfillments": "Accepted"
}

Refund a payment

Refund the payment

Partially or fully refund your payment through our Card Payments API using the next action link received in your authorization response.

Refund an authorization

To refund all the funds to a customer, send us a refund request.

POST to the cardPayments:refund action link, returned in the authorization response, to refund an authorization.

Refund request

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