Settle for partial amount

Request

To receive a portion of the funds of a payment, send us a partial settle request.

Security

BasicAuth

Path

linkDatastringrequired

Action link that's received in your request.

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]*$required

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

Example:"partial-settle-reference"

valueobjectrequired

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

sequenceobject

The sequence number and total number of expected partial settlement requests for the payment.

Request to partially settle the authorization

{
  "sequence": {
    "number": 1,
    "total": 2
  },
  "value": {
    "amount": 500,
    "currency": "EUR"
  },
  "reference": "partial-settle-reference"
}

Responses

The partial 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"

_linksobject

Response

Response to partially settle the authorization

{
  "paymentId": "payI-dUcet9fk4_X4qZU0hpU0",
  "commandId": "cmdwZ5y_rSi1VmjD6CpgCuXG0",
  "_links": {
    "cardPayments:refund": {
      "href": "/payments/settlements/refunds/full/:linkData"
    },
    "cardPayments:partialRefund": {
      "href": "/payments/settlements/refunds/partials/:linkData"
    },
    "cardPayments:partialSettle": {
      "href": "/payments/settlements/partials/:linkData"
    },
    "cardPayments:reverse": {
      "href": "/payments/authorizations/reversals/:linkData"
    },
    "cardPayments:cancel": {
      "href": "/payments/authorizations/cancellations/:linkData"
    },
    "cardPayments:events": {
      "href": "/payments/events/:linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}