APIs
/
Events
/
payment
/
topUpRejected

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
Overview
License

Worldpay

Languages
Servers
Merchant Webhook Path

https://merchant-defined-url.com/

payment

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

Webhooks

topUpAcceptedWebhook

Request

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

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

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"
transactionReferencestring

The transaction reference you supplied in the payment

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "topUpAccepted"
datestring(date)

The date you first submitted the payment

amountobject
paymentInstrumentobject
_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",
    "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

topUpRejectedWebhook

Request

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

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

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"
transactionReferencestring

The transaction reference you supplied in the payment

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "topUpRejected"
datestring(date)

The date you first submitted the payment

amountobject
paymentInstrumentobject
_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",
    "transactionReference": "Memory265-13/08/1876",
    "type": "topUpRejected",
    "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 payout events/webhooks to a URL defined by you.

Webhooks

chargeback

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

Webhooks