Skip to content
APIs/Events/
/
settled

Events (1)

Receive status updates from Access Worldpay by setting up a webhook.

Contact your Implementation Manager to add your webhook URL and enable or disable the events based on your requirement.

The webhook destination (URL) must use an encrypted connection (https) and have a certificate signed by a trusted certificate authority. Every certificate within the chain, including the root, must be using a certificate signing algorithm of SHA-256 or better.

Support for certificate chains involving any certs with the SHA-1 certificate signing algorithm ends March 2026.

Developer documentation.
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Merchant Webhook Path
https://merchant-defined-url.com

Payment

Receive payment events/webhooks to a URL defined by you.

Webhooks

sentForSettlementWebhook

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.

eventIdstring

The unique identifier for the event.

eventTimestampstring

Date of event.

eventDetailsobject
classificationstring

The event category, this can either be payout, payment or chargeback.

Example: "payment"
downstreamReferencestring

A reference you can use for reconciliation purposes.

transactionReferencestring

The transaction reference you supplied in the payment.

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "sentForSettlement"
datestring(date)

The date you first submitted the payment.

referencestring

The unique reference you provided for a partial settlement or partial refund.

amountobject
_linksobject

Unused currently.

application/vnd.worldpay.events-v1.hal+json
{
  "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
  "eventTimestamp": "2018-06-13T14:18:13.407",
  "eventDetails": {
    "classification": "payment",
    "downstreamReference": "3378792436",
    "transactionReference": "Memory265-13/08/1876",
    "type": "sentForSettlement",
    "date": "2017-11-03",
    "reference": "12345",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "_links": {
      "payment": {
        "href": ""
      }
    }
  }
}

Responses

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

settledWebhook

Request

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

We have received the funds and are preparing to transfer them to your bank account. This event is only available in certain use cases. Please speak to your Implementation Manager for more details.

eventIdstring

The unique identifier for the event.

eventTimestampstring

Date of event.

eventDetailsobject
classificationstring

The event category, this can either be payout, payment or chargeback.

Example: "payment"
downstreamReferencestring

A reference you can use for reconciliation purposes.

transactionReferencestring

The transaction reference you supplied in the payment.

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "settled"
datestring(date)

The date you first submitted the payment.

amountobject
_linksobject

Unused currently.

application/vnd.worldpay.events-v1.hal+json
{
  "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
  "eventTimestamp": "2018-06-13T14:18:13.407",
  "eventDetails": {
    "classification": "payment",
    "downstreamReference": "3378792436",
    "transactionReference": "Memory265-13/08/1876",
    "type": "settled",
    "date": "2017-11-03",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "_links": {
      "payment": {
        "href": ""
      }
    }
  }
}

Responses

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

settlementFailedWebhook

Request

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

The settlement couldn't be processed and funds have not been transferred to your Worldpay account. This event is only available in certain use cases. Please speak to your Implementation Manager for more details.

eventIdstring

The unique identifier for the event.

eventTimestampstring

Date of event.

eventDetailsobject
classificationstring

The event category, this can either be payout, payment or chargeback.

Example: "payment"
downstreamReferencestring

A reference you can use for reconciliation purposes.

transactionReferencestring

The transaction reference you supplied in the payment.

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "settlementFailed"
datestring(date)

The date you first submitted the payment.

amountobject
_linksobject

Unused currently.

application/vnd.worldpay.events-v1.hal+json
{
  "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
  "eventTimestamp": "2018-06-13T14:18:13.407",
  "eventDetails": {
    "classification": "payment",
    "downstreamReference": "3378792436",
    "transactionReference": "Memory265-13/08/1876",
    "type": "settlementFailed",
    "date": "2017-11-03",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "_links": {
      "payment": {
        "href": ""
      }
    }
  }
}

Responses

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

Payout

Receive card payout events/webhooks to a URL defined by you.

For account payouts events please see our Account Payouts event webhook guide.

Webhooks

Chargeback

Receive chargeback events/webhooks to a URL defined by you.

Webhooks