APIs
/
Events
/
payment
/
refused

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

expiredWebhook

Request

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

The authorization period ended before a settlement or cancel request was made.

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: "expired"
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": "expired",
    "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

refusedWebhook

Request

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

Your payment request has been declined by a third party.

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: "refused"
datestring(date)

The date you first submitted the payment

octReferencestring

Visa Transaction ID for single-message OCTs to be used for reconciliation and reporting. Can be returned in the sentForRefund or refused Payment Events

_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": "refused",
    "date": "2017-11-03",
    "octReference": "12345",
    "_links": {
      "payment": {
        "href": ""
      }
    }
  }
}

Responses

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

sentForRefundWebhook

Request

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

You've requested funds to be sent back to your customer's account. If online authorization was required, this will also contain the refund.onlineRefundAuthorization. Payouts through basic disbursement triggers this event.

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: "sentForRefund"
datestring(date)

The date you first submitted the payment

referencestring

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

refundobject
octReferencestring

Visa Transaction ID for single-message OCTs to be used for reconciliation and reporting. Can be returned in the sentForRefund or refused Payment Events

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": "sentForRefund",
    "date": "2017-11-03",
    "reference": "12345",
    "refund": {
      "onlineRefundAuthorization": "987654"
    },
    "octReference": "12345",
    "amount": {
      "value": 100,
      "currencyCode": "EUR"
    },
    "_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