Payouts root resource, returns links to available payouts actions.
Download OpenAPI specification:Download
Payouts root resource, returns links to available payouts actions.
testing (try)
live
Retrieve the details of an existing Basic Disbursement or Fast Access Payout.
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 } ] } }
Query by transaction reference and entity to retrieve a Payout.
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 } ] } }
Disburse funds to a payout instrument.
Successful Basic Disbursement
{ "merchant": { "entity": "default" }, "instruction": { "value": { "amount": 300, "currency": "GBP" }, "payoutInstrument": { "type": "card/plain", "cardHolderName": "Mr Arjen Lucassen", "cardExpiryDate": { "month": 1, "year": 2025 }, "cardNumber": "4444333322221111", "billingAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" } }, "narrative": { "line1": "STATEMENT", "line2": "OPTIONAL" } }, "transactionReference": "transaction-ref" }
201
Funds have been disbursed or queued for disbursal successfully.
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 } ] } }
Disburse funds to a payout instrument using fastAccess.
Successful issuing of a disbursal request
{ "merchant": { "entity": "default" }, "instruction": { "value": { "amount": 300, "currency": "GBP" }, "payoutInstrument": { "type": "card/plain", "cardHolderName": "Mr Arjen Lucassen", "cardExpiryDate": { "month": 1, "year": 2025 }, "cardNumber": "4444333322221111", "billingAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" } }, "narrative": { "line1": "STATEMENT", "line2": "OPTIONAL" } }, "transactionReference": "transaction-ref" }
201
Funds have been disbursed or queued for disbursal successfully.
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 } ] } }