APIs
/
Events
/
payout
/
approved

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

payout

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

Webhooks

disbursedWebhook

Request

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

Your Fast Access disbursement request has been disbursed

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

The transaction reference you supplied in the payment

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "disbursed"
datestring(date)

The date you first submitted the payment

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

Responses

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

pendingWebhook

Request

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

Your Fast Access disbursement request has been sent to Visa Direct, and a response is pending. Pending requests usually update to approved or refused within 45 minutes. If no response is received within 48 hours, an error is returned.

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

The transaction reference you supplied in the payment

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "pending"
datestring(date)

The date you first submitted the payment

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

Responses

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

refusedWebhook

Request

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

Your Fast Access disbursement request was refused.

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: "payout"
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

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

Responses

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

requestedWebhook

Request

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

Access Payouts has received your Fast Access disbursement 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: "payout"
transactionReferencestring

The transaction reference you supplied in the payment

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "requested"
datestring(date)

The date you first submitted the payment

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

Responses

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

approvedWebhook

Request

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

Visa Direct has approved your Fast Access disbursement request. Your customer should receive the funds within 30 minutes if their issuer is Fast Access enabled, or 3-5 working days if they are not.

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

The transaction reference you supplied in the payment

typestring

Event status. For example, cancelled or sentForAuthorization.

Example: "approved"
datestring(date)

The date you first submitted the payment

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

Responses

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

chargeback

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

Webhooks