Skip to content
APIs/Events/
/
sentForSettlement

sentForSettlement
Webhook

Request

Bodyapplication/vnd.worldpay.events-v1.hal+json

You or Access Worldpay have requested to remove the reserved funds in your customer's account and transfer them to your Worldpay account.

One of:
eventIdstring

The unique identifier for the event.

Example:"bb55ca5a-e05c-47e1-8e94-e88bac1a0a17"
eventTimestampstring

Date of event.

Example:"2018-06-13T14:18:13.407"
eventDetailsobject
Payload
{
  "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
  "eventTimestamp": "2018-06-13T14:18:13.407",
  "eventDetails": {
    "classification": "payment",
    "downstreamReference": "3378792436",
    "orderReference": "my-order-ref",
    "transactionReference": "Memory265-13/08/1876",
    "paymentId": "payI-dUcet9fk4_X4qZU0hpU0",
    "commandId": "cmd-Rjc4HJwnBdj3Ri9v10vT0",
    "merchant": {
      "entity": "default"
    },
    "type": "sentForSettlement",
    "date": "2017-11-03",
    "reference": "ABC123",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "_links": {
      "payment": {
        "href": ""
      }
    }
  }
}

Responses

Return a 200 status to indicate that the data was received successfully