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-v7+json
Acceptstringrequired
Example:application/vnd.worldpay.payments-v7+json
Bodyapplication/vnd.worldpay.payments-v7+json
referencestring, [ 1 .. 128 ] characters^[-A-Za-z0-9]*$

A reference generated by you to identify a payment throughout its lifecycle.

Example:"full-settle-reference"
valueobject

An object that contains information about the value of the payment.

merchantobject

Contains information about the merchant.

customerobject

Additional customer data.

shippingobject

An object containing shipping details.

orderobject

An object containing details about the order.

industryDataobject

Request to settle the authorization

// No request payload

Responses

The payment settlement has been accepted

Bodyapplication/vnd.worldpay.payments-v7+json
paymentIdstring, [ 21 .. 36 ] characters^[A-Za-z0-9_-]+$

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

Example:"payI-dUcet9fk4_X4qZU0hpU0"
commandIdstring, [ 21 .. 36 ] characters^[A-Za-z0-9_-]+$

Unique identifier generated by us for a single instance of an interaction (command) with the Worldpay API.

Example:"cmdRvD-OxCyXgJLQ9_jbqXAC0"
Response

Response to fully settle the authorization

{
  "paymentId": "payT7hS-8vS4h_95A2f7905v0",
  "commandId": "cmdp9D1t-ENYQxVnJkh0iPRC0",
  "_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
      }
    ]
  }
}