Skip to content
APIs
/
Account Payouts
/
Batch payout
/
Make a batch payout

Account Payouts (2025-01-01)

Send funds to your customer's bank accounts and search for payouts using parameters.

Authentication Header

  Authorization: {your_credentials}

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.

You must use the Authorization header for any request you send to our Account Payouts API

WP-Api-Version Header

  WP-Api-Version: 2025-01-01

We use the WP-Api-Version header to identify which version of our API you are using.

DNS Whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Worldpay

Languages
Servers
Try

https://try.access.worldpay.com/

Live

https://access.worldpay.com/

Single payout

Make a single payout to an account using our Account Payouts endpoint.

Operations

Batch payout

Make up to 500 payouts in one batch using our Account Payouts endpoint.

Operations

Make a batch 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 1755009817
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 1234567890
Example: 1234567890
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
entitystring[ 1 .. 32 ]required

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

Example: "default"
payoutsArray of objects or null[ 1 .. 500 ]

Holds information about the individual payouts.

instructionobject
transactionReferencestring[ 6 .. 50 ]required

Unique reference for the payout request provided by you.

merchantobject
notificationUrlstring or null

Currently not in use.

application/json
{
  "merchant": {
    "entity": "default"
  },
  "payouts": [
    {
      "instruction": {
        "value": {
          "sourceCurrency": "EUR",
          "sourceAmount": 0,
          "targetCurrency": "EUR",
          "targetAmount": 199.99
        },
        "narrative": {
          "line1": "Testing invalid bank details"
        },
        "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"
    },
    {
      "instruction": {
        "value": {
          "sourceCurrency": "EUR",
          "sourceAmount": 0,
          "targetCurrency": "EUR",
          "targetAmount": 199.99
        },
        "narrative": {
          "line1": "Testing invalid bank details"
        },
        "countryCode": "GB",
        "beneficiaryBankDetails": {
          "iban": "GB41CITI18500818401243",
          "bankName": "Citibank London"
        },
        "parties": [
          {
            "partyType": "beneficiary",
            "personalDetails": {
              "type": "Company",
              "companyName": "Worldpay Ltd"
            },
            "address": {
              "address1": "The Science Park",
              "city": "Cambridge",
              "postalCode": "CB4 0WE",
              "countryCode": "GB"
            }
          }
        ]
      },
      "transactionReference": "ABC123456-invalidBankDetails"
    }
  ]
}

Responses

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

Bodyapplication/jsonArray [
transactionReferencestring or null
payoutRequestIdstring or null
]
Response
application/json
[
  {
    "transactionReference": "202401",
    "payoutRequestId": "PN000CYV"
  },
  {
    "transactionReference": "202402",
    "payoutRequestId": "PN000CYW"
  },
  {
    "transactionReference": "202403",
    "payoutRequestId": "PN000CYX"
  },
  {
    "transactionReference": "202404",
    "payoutRequestId": "PN000CYY"
  },
  {
    "transactionReference": "202405",
    "payoutRequestId": "PN000CYZ"
  },
  {
    "transactionReference": "202406",
    "payoutRequestId": "PN000CY2"
  },
  {
    "transactionReference": "202407",
    "payoutRequestId": "PN000CY3"
  },
  {
    "transactionReference": "202408",
    "payoutRequestId": "PN000CY4"
  },
  {
    "transactionReference": "202409",
    "payoutRequestId": "PN000CY5"
  }
]

Get payouts by Payout Request ID

Search for payout details by using a Payout Request ID.

Operations

Get payouts

Search for payout details by filtering parameters.

Operations