Payouts root resource, returns links to available payouts actions.
Payouts root resource, returns links to available payouts actions.
No request payload
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.com/payouts/{resource}" } }, "curies": [ { "name": "payouts", "href": "https://try.access.worldpay.com/rels/payouts/{rel}", "templated": true } ] }
No request payload
Basic Disbursement: An existing resource is retrieved with outcome 'requestReceived'
{ "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 } ] }
Basic disbursement input.
An object that contains information about the merchant.
Successful Basic Disbursement
{ "merchant": { "entity": "default" }, "instruction": { "value": { "amount": 300, "currency": "GBP" }, "payoutInstrument": { "type": "card/plain", "cardHolderName": "Sherlock Holmes", "cardExpiryDate": { "month": 1, "year": 2025 }, "cardNumber": "4444333322221111" }, "narrative": "STATEMENT" }, "transactionReference": "transaction-ref" }
Successful Basic Disbursement
{ "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 } ] }
An object that contains all the information related to your payout request.
An object that contains information about the merchant.
Successful issuing of a disbursal request
{ "merchant": { "entity": "default" }, "instruction": { "value": { "amount": 300, "currency": "GBP" }, "payoutInstrument": { "type": "card/plain", "cardHolderName": "Sherlock Holmes", "cardExpiryDate": { "month": 1, "year": 2025 }, "cardNumber": "4444333322221111" }, "narrative": "STATEMENT" }, "transactionReference": "transaction-ref" }
Successful issuing of a disbursal request
{ "outcome": "pending", "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 } ] }