Make a single payout

APIs/Account Payouts/Single payout/

Request

Security

BasicAuth

Headers

WP-CorrelationIdstring

A unique identifier used to trace and correlate a request across systems. Must be a GUID.

Example:15cd16b2-7b82-41cb-9b11-21be9dacad88

WP-Timestampstring

Default:"1755681620"

WP-Api-Versionstring

The version of the API you are using.

Default:"2025-01-01"

Example:2025-01-01

Idempotency-Keystring, [ 1 .. 35 ]

A unique key to identify the request. This is used to prevent duplicate processing of the same request.

Default:"mustBeUnique12345"

Example:mustBeUnique12345

Content-Typestring

Specifies the media type of the resource or the data being sent. This field informs the server or client how to interpret the body of the request or response.

Default:"application/json"

Example:application/json

Bodyapplication/json

merchantobject

instructionobject

transactionReferencestring, [ 6 .. 50 ]required

Reference for the payout request provided by you. We recommend you specify a value which is unique across all of your payouts to ensure you receive the right data throughout the payout lifecycle. Special characters are allowed.

notificationUrlstring or null, <= 250

Currently not in use.

{
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "value": {
      "sourceCurrency": "EUR",
      "sourceAmount": 0,
      "targetCurrency": "EUR",
      "targetAmount": 199.99
    },
    "narrative": {
      "line1": "PushtoAccount with Worldpay"
    },
    "countryCode": "GB",
    "beneficiaryBankDetails": {
      "iban": "GB41CITI18500818404062",
      "bankName": "Citibank London"
    },
    "parties": [
      {
        "partyType": "beneficiary",
        "personalDetails": {
          "type": "Company",
          "companyName": "Worldpay AP Ltd"
        },
        "address": {
          "address1": "25 Walbrook",
          "city": "London",
          "postalCode": "EC4N 8AF",
          "countryCode": "GB"
        }
      }
    ]
  },
  "transactionReference": "ABC123456"
}

Responses

OK response if a request with the same credentials has already been submitted successfully

Bodyapplication/json

payoutRequestIdstring

Payout Request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters.

idempotencyKeyany

Unique reference from the request header of the same name.

entitystring

Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.

Response

{
  "payoutRequestId": "PZ000EC4",
  "idempotencyKey": "mustBeUnique12345",
  "entity": "default"
}