Payouts
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",
"properties": {
"curies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"name": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href",
"name",
"templated"
]
}
},
"payouts:basicDisbursement": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
},
"payouts:fastAccess": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
},
"payouts:payout": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
},
"payouts:query": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
},
"resourceTree": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
}
},
"required": [
"curies",
"payouts:basicDisbursement",
"payouts:fastAccess",
"payouts:payout",
"payouts:query",
"resourceTree"
]
}
},
"required": [
"_links"
]
}
{ "type": "object", "properties": { "_links": { "type": "object", "properties": { "curies": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "name": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href", "name", "templated" ] } }, "payouts:basicDisbursement": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] }, "payouts:fastAccess": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] }, "payouts:payout": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] }, "payouts:query": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] }, "resourceTree": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] } }, "required": [ "curies", "payouts:basicDisbursement", "payouts:fastAccess", "payouts:payout", "payouts:query", "resourceTree" ] } }, "required": [ "_links" ] }
Examples
Link relationship
payouts:basicDisbursement
Payout to an Account.
payouts:fastAccess
Payout to an Account using fastAccess.
payouts:payouts
Retrieve a previous Payout.
payouts:query
Allows retrieving the details of a historic resource.
resourceTree
A document showing possible interactions with the payouts API.
Retrieve the payouts top-level collection resource.
GEThttps://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
}
]
}
}
{ "_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 } ] } }