Payouts root resource, returns links to available payouts actions.

Methods

GET

Retrieve links to next available actions.

Responses

Response schema

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

Examples

GET
 Retrieve the payouts top-level collection resource.
View

Link relationship

get
 Retrieve the payouts top-level collection resource. 
GET https://try.access.worldpay.com/payouts/

200

Copied!
{
  "_links": {
    "resourceTree": {
      "href": "https://try.access.worldpay.com/payouts/resourceTree"
    },
    "payouts:basicDisbursement": {
      "href": "https://try.access.worldpay.com/payouts/basicDisbursement",
      "templated": true
    },
    "payouts:fastAccess": {
      "href": "https://try.access.worldpay.com/payouts/fastAccess",
      "templated": true
    },
    "payouts:payout": {
      "href": "https://try.access.worldpay.com/payouts/{resource}",
      "templated": true
    },
    "payouts:query": {
      "href": "https://try.access.worldpay.com/payouts/query",
      "templated": true
    },
    "curies": [
      {
        "name": "payouts",
        "href": "https://try.access.worldpay.com/rels/payouts/{rel}",
        "templated": true
      }
    ]
  }
}