Retrieve payout details from a historic resource

Request

Query by transaction reference and entity to retrieve a payout.

Security

BasicAuth

Query

transactionReferencestringrequired

A unique reference generated by you, used to identify a payout throughout its lifecycle.

Example:transactionReference=12345

entitystringrequired

merchant entity

Example:entity=default

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/payouts/query?transactionReference=12345&entity=default'

Responses

Returns a payout resource, provided one matches the transaction and entity references.

Bodyapplication/vnd.worldpay.payouts-v4+json

outcomestringrequired

outcome of payouts query request

schemeobject

receivedAtstringrequired

A timestamp of receivedAt

Response

Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'

{
  "outcome": "requestReceived",
  "receivedAt": "2025-08-01T10:37:36.923Z",
  "_links": {
    "payouts:payout": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/payouts/{resource}"
    },
    "curies": [
      {
        "name": "payouts",
        "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payouts/{rel}",
        "templated": true
      }
    ]
  }
}