Query by transaction reference and entity to retrieve a Payout.

Methods

GET

Retrieve the payout details of a historic resource.

Responses

Response schema

Copied!
{
 "type": "object",
 "properties": {
  "_links": {
   "type": "object",
   "format": "hal+json"
  },
  "outcome": {
   "type": "string"
  },
  "receivedAt": {
   "type": "string"
  }
 },
 "required": [
  "_links",
  "outcome",
  "receivedAt"
 ]
}

Examples

GET
 Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'
View
GET
 Basic Disbursement: An existing resource is retrieved with outcome 'refused'
View
GET
 Basic Disbursement: An existing resource is retrieved with outcome 'error'
View
GET
 Fast Access: An existing resource is retrieved with outcome 'requested'
View
GET
 Fast Access: An existing resource is retrieved with outcome 'pending'
View
GET
 Fast Access: An existing resource is retrieved with outcome 'approved'
View
GET
 Fast Access: An existing resource is retrieved with outcome 'disbursed'
View
GET
 Fast Access: An existing resource is retrieved with outcome 'refused'
View
GET
 Fast Access: An existing resource is retrieved with outcome 'error'
View

Link relationship

get
 Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived' 
GET https://try.access.worldpay.com/payouts/query?transactionReference={transactionReference}&entity={entity}
Copied!
{
  "Authorization": "Basic Auth",
  "Accept": "application/vnd.worldpay.payouts-v3+json"
}

200

Copied!
{
  "outcome": "requestReceived",
  "receivedAt": "2018-09-01T10:37:36.923Z",
  "_links": {
    "payouts:payout": {
      "href": "https://try.access.worldpay.com/payouts/{resource}"
    },
    "curies": [
      {
        "name": "payouts",
        "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
        "templated": true
      }
    ]
  }
}