Skip to content
/
Settle an APM payment

Settle an APM payment

Request

Perform a settlement on authorized funds. Not all APMs support this, please check the links returned from querying a payment.

Security
BasicAuth
Path
paymentIdstringrequired

The identifier of the payment resource.

Headers
Content-Typestringrequired

The content type of the request body.

Value:"application/json"
WP-Api-Versionstringrequired

The API version.

Value:"2023-06-01"
Bodyapplication/jsonrequired
One of:

Full settlement request (no body)

object
// No request payload

Responses

Request successful

Bodyapplication/json
_actionsobject

Actions that can be performed on the payment resource. These are dynamic based on factors such as the payment instrument and state of the payment.

lastEventstring
Enum:"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""settlementFailed""chargebackReversed""chargedBack""disputeExpired""disputeFundsHeld"
paymentIdstring

The identifier of the payment resource.

urlstring

The URL of where to redirect tyour customer.

Response
{
  "id": "3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f",
  "lastEvent": "sentForSettlement",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apmPayments/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"
    }
  },
  "_actions": {}
}