Skip to content

Standard payout

Request

Disburse funds to a payout instrument.

Security
BasicAuth
Bodyapplication/vnd.worldpay.payouts-v4+json
instructionobjectrequired

An object that contains all the information related to your payout request.

merchantobjectrequired

An object that contains information about the merchant.

transactionReferencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$required

A unique reference generated by you, used to identify a payout throughout its lifecycle.

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", "billingAddress": { "address1": "address1", "address2": "address2", "address3": "address3", "postalCode": "postalCode", "city": "city", "state": "state", "countryCode": "GB" } }, "narrative": { "line1": "STATEMENT", "line2": "OPTIONAL" } }, "transactionReference": "transaction-ref" }

Responses

The outcome of your card payout request.

Bodyapplication/vnd.worldpay.payouts-v4+json
outcomestringrequired

Outcome of payouts request.

receivedAtstringrequired

A timestamp of receivedAt.

Response

Successful Basic Disbursement

{ "outcome": "requestReceived", "receivedAt": "2025-08-01T10:37:36.923Z", "_links": { "payouts:payout": { "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/payouts/{resource}" }, "curies": [ { "name": "payouts", "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/payouts/{rel}", "templated": true } ] } }