Skip to content
APIs/Card Payments/Manage payments

Settle for full amount

Request

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

Security
BasicAuth
Path
linkDatastringrequired

Action link that's received in your request

Headers
Content-Typestringrequired
Example:application/vnd.worldpay.payments-v6+json
Acceptstring
Example:application/vnd.worldpay.payments-v6.hal+json
curl -i -X POST \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/settlements/{linkData}' \
  -H 'Accept: application/vnd.worldpay.payments-v6.hal+json' \
  -H 'Content-Type: application/vnd.worldpay.payments-v6+json'

Responses

The payment settlement has been accepted

Bodyapplication/vnd.worldpay.payments-v6.hal+json
Response

Request to fully settle the authorization

{
  "_links": {
    "payments:refund": {
      "href": "/payments/settlements/refunds/full/:linkData"
    },
    "payments:partialRefund": {
      "href": "/payments/settlements/refunds/partials/:linkData"
    },
    "payments:events": {
      "href": "/payments/events/:linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}