Skip to content
APIs/Card Payouts/
Retrieve payout details

Retrieve payout details

Request

Retrieve the details of an existing basic disbursement or Fast Access payout.

Security
BasicAuth
Path
resourcestringrequired

original resource

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/payouts/{resource}'

Responses

Payout resource.

Bodyapplication/vnd.worldpay.payouts-v3+json
outcomestringrequired

outcome of payouts request

receivedAtstringrequired

A timestamp of receivedAt

Response

Basic Disbursement: Successful resource retrieval with outcome requestReceived

{
  "outcome": "requestReceived",
  "receivedAt": "2023-09-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
      }
    ]
  }
}