Retrieve
Retrieve the details of an existing Basic Disbursement or Fast Access Payout.
Methods
GET
Retrieve payout details
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:payout": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
},
"payouts:update": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"templated": {
"type": "boolean"
}
},
"required": [
"href"
]
}
},
"required": [
"curies",
"payouts:payout"
]
},
"outcome": {
"type": "string"
},
"receivedAt": {
"type": "string"
}
},
"required": [
"_links",
"outcome",
"receivedAt"
]
}{ "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:payout": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] }, "payouts:update": { "type": "object", "properties": { "href": { "type": "string" }, "templated": { "type": "boolean" } }, "required": [ "href" ] } }, "required": [ "curies", "payouts:payout" ] }, "outcome": { "type": "string" }, "receivedAt": { "type": "string" } }, "required": [ "_links", "outcome", "receivedAt" ] }
Examples
Link relationship
payouts:payoutQuery a payout.
Basic Disbursement: Successful resource retrieval with outcome requestReceived
GEThttps://try.access.worldpay.com/payouts/{resource}
Copied!
{
"Authorization": "Basic Auth",
"Accept": "application/vnd.worldpay.payouts-v4+json"
}{ "Authorization": "Basic Auth", "Accept": "application/vnd.worldpay.payouts-v4+json" }
200
Copied!
{
"outcome": "requestReceived",
"receivedAt": "2023-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
}
]
}
}{ "outcome": "requestReceived", "receivedAt": "2023-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 } ] } }
