APIs
/
Account Payouts
/
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, unless you are using client certificate authentication with SSL/TLS.

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. You must use the Accept header for any request you send to our Account Payouts API.

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

Headers
WP-CorrelationIdstring

A unique key to identify the request. Must be a GUID.

Example: 15cd16b2-7b82-41cb-9b11-21be9dacad88
WP-Timestampstring
Default 1745593477
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 requests.

Default 1234567890
Example: 1234567890
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
subOrgIdstring or null
notificationUrlstring or null

Currently not in use.

application/json
{
  "merchant": {
    "entity": "Titan"
  },
  "payouts": [
    {
      "instruction": {
        "beneficiaryBankDetails": {
          "accountType": "checking",
          "accountNumber": "12345678",
          "address": { … },
          "iban": "GB29NWBK60161331926819",
          "branchCode": "300",
          "bankCode": "404433",
          "swiftBic": "BUKBGB22",
          "bankName": "Bank of Salford"
        },
        "value": {
          "sourceCurrency": "GBP",
          "sourceAmount": 0,
          "targetCurrency": "",
          "targetAmount": 10
        },
        "parties": [
          { … },
          { … }
        ],
        "narrative": {
          "line1": "batch01MT"
        },
        "purposeOfPayment": {
          "code": "WPP",
          "description": "batch01MT"
        },
        "transactionType": "customerToCustomer",
        "fastPayment": true,
        "countryCode": "GB",
        "expandableKeyValuePairs": {
          "property1": "test1",
          "property2": "test2"
        },
        "channel": "Tron",
        "quoteId": "",
        "scheduleDate": ""
      },
      "transactionReference": "batch01MT"
    },
    {
      "instruction": {
        "beneficiaryBankDetails": {
          "accountType": "checking",
          "accountNumber": "12345678",
          "address": { … },
          "iban": "GB29NWBK60161331926819",
          "branchCode": "300",
          "bankCode": "404433",
          "swiftBic": "BUKBGB22",
          "bankName": "Bank of Salford"
        },
        "value": {
          "sourceCurrency": "GBP",
          "sourceAmount": 0,
          "targetCurrency": "",
          "targetAmount": 10
        },
        "parties": [
          { … },
          { … }
        ],
        "narrative": {
          "line1": "batch01MT"
        },
        "purposeOfPayment": {
          "code": "WPP",
          "description": "batch01MT"
        },
        "transactionType": "customerToCustomer",
        "fastPayment": true,
        "countryCode": "GB",
        "expandableKeyValuePairs": {
          "property1": "test1",
          "property2": "test2"
        },
        "channel": "Stellar",
        "quoteId": "",
        "scheduleDate": ""
      },
      "transactionReference": "batch02MT"
    }
  ]
}

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