Submit a payment settle request

Request

Send a settle request to receive all the funds of a payment.

Note: No request body is needed for this request.

Security

BasicAuth

Path

linkDatastringrequired

WP-Api-Versionstringrequired

The API version

Value:"2024-06-01"

Example:2024-06-01

curl -i -X POST \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/api/payments/{linkData}/settlements' \
  -H 'WP-Api-Version: 2024-06-01'

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.

_linksobject

Return details about the status of the payment.

_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"
    },
    "reversePayment": {
      "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9/reversals",
      "method": "POST"
    }
  }
}