Skip to content
APIs/Payments/
/
Submit a payment partial...

Submit a payment partial settle request

Request

Send a partial settle request to receive a portion of the funds of a payment.

Note: Send the amount to settle and the authorization currency in the body.

Security
BasicAuth
Path
linkDatastringrequired
Headers
WP-Api-Versionstringrequired

The API version

Value:"2024-06-01"
Example:2024-06-01
Bodyapplication/jsonrequired
referencestring, non-emptyrequired
sequenceobject

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

valueobjectrequired

The value and currency.

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

Responses

Accepted

Bodyapplication/json
outcomestring
Value:"sentForSettlement"
paymentIdstring^[A-Za-z0-9_-]+$

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

_actionsobject
Response
{
  "outcome": "sentForSettlement",
  "paymentId": "payI-dUcet9fk4_X4qZU0hpU0",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9"
    }
  },
  "_actions": {
    "refundPayment": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9/refunds",
      "method": "POST"
    },
    "partiallyRefundPayment": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9/partialRefunds",
      "method": "POST"
    },
    "partiallySettlePayment": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9/partialSettlements",
      "method": "POST"
    },
    "reversePayment": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9/reversals",
      "method": "POST"
    },
    "cancelPayment": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9/cancellations",
      "method": "POST"
    }
  }
}