Skip to content
APIs/Events/
/
settlementRejected

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 must also have a certificate signed by a trusted certificate authority.

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

settlementInstructedWebhook

Request

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

We've received instruction about your settlement.

eventIdstring
eventTimestampstring
eventDetailsobject
classificationstring

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

Example: "payment"
transactionReferencestring
typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "settlementInstructed"
datestring(date)
amountobject
paymentInstrumentobject
_linksobject
application/vnd.worldpay.events-v1.hal+json
{
  "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
  "eventTimestamp": "2018-06-13T14:18:13.407",
  "eventDetails": {
    "classification": "payment",
    "transactionReference": "Memory265-13/08/1876",
    "type": "settlementInstructed",
    "date": "2017-11-03",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "paymentInstrument": {
      "method": "pix",
      "bankCode": "13935893",
      "branchCode": "0001",
      "accountName": "John Doe",
      "accountNumber": "30054759318",
      "accountType": "TRAN",
      "documentNumber": "43394559000156",
      "bookingDate": "2025-05-02"
    },
    "_links": {
      "payment": {
        "href": ""
      }
    }
  }
}

Responses

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

settlementRejectedWebhook

Request

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

We've received instruction about your settlement failure.

eventIdstring
eventTimestampstring
eventDetailsobject
classificationstring

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

Example: "payment"
transactionReferencestring
typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "settlementRejected"
datestring(date)
amountobject
paymentInstrumentobject
_linksobject
application/vnd.worldpay.events-v1.hal+json
{
  "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
  "eventTimestamp": "2018-06-13T14:18:13.407",
  "eventDetails": {
    "classification": "payment",
    "transactionReference": "Memory265-13/08/1876",
    "type": "settlementRejected",
    "date": "2017-11-03",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "paymentInstrument": {
      "method": "pix",
      "bankCode": "13935893",
      "branchCode": "0001",
      "accountName": "John Doe",
      "accountNumber": "30054759318",
      "accountType": "TRAN",
      "documentNumber": "43394559000156",
      "bookingDate": "2025-05-02"
    },
    "_links": {
      "payment": {
        "href": ""
      }
    }
  }
}

Responses

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

topUpAcceptedWebhook

Request

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

We've received instruction about your top-up request.

eventIdstring
eventTimestampstring
eventDetailsobject
classificationstring

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

Example: "payment"
transactionReferencestring
typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "topUpAccepted"
datestring(date)
amountobject
paymentInstrumentobject
_linksobject
application/vnd.worldpay.events-v1.hal+json
{
  "eventId": "bb55ca5a-e05c-47e1-8e94-e88bac1a0a17",
  "eventTimestamp": "2018-06-13T14:18:13.407",
  "eventDetails": {
    "classification": "payment",
    "transactionReference": "Memory265-13/08/1876",
    "type": "topUpAccepted",
    "date": "2017-11-03",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "paymentInstrument": {
      "method": "pix",
      "bankCode": "13935893",
      "branchCode": "0001",
      "accountName": "John Doe",
      "accountNumber": "30054759318",
      "accountType": "TRAN",
      "documentNumber": "43394559000156",
      "bookingDate": "2025-05-02"
    },
    "_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