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

Make a batch payout to an account

Request

Security
BasicAuth
Headers
WP-CorrelationIdstring
Example:15cd16b2-7b82-41cb-9b11-21be9dacad88
WP-CallerIdstring

An ID used for logging purposes.

WP-Timestampstring
Default:"1743087806"
Content-Typestring
Default:"application/vnd.worldpay.wts.payout-v2+json"
Example:application/vnd.worldpay.wts.payout-v2+json
Bodyapplication/vnd.worldpay.wts.payout-v2+json
requesterDetailsobject
payoutsArray of objects or null
{
  "requesterDetails": {
    "instructingTreasuryId": "000055",
    "entity": "000055",
    "apiRequestReference": "mustBeUnique12345",
    "notificationUrl": null
  },
  "payouts": [
    {
      "countryCode": "GB",
      "expandableKeyValuePairs": {
        "remitterSourceOfIncome": "salary",
        "beneficiaryNationality": "British"
      },
      "quoteId": "",
      "bankDetails": {
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "address": {
          "city": "Sale",
          "state": "Cheshire",
          "countryCode": "GB",
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "postcodeOrZipCode": "M33 7ZA"
        }
      },
      "transactionReference": "123456",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "parties": [
        {
          "partyTypeCode": "PT03",
          "personalDetails": {
            "companyName": null,
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "typeCode": "PD02",
            "titleCode": "TI01",
            "telephony": [
              { … }
            ],
            "identity": [
              { … }
            ]
          },
          "address": {
            "city": "Some City",
            "state": "Some State",
            "countryCode": "GB",
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "postcodeOrZipCode": "S14 T4R",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          },
          "customerPartyId": "customer123"
        },
        {
          "partyTypeCode": "PT01",
          "personalDetails": {
            "companyName": "testCompanyInc",
            "firstName": null,
            "middleName": null,
            "lastName": null,
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "typeCode": "PD01",
            "titleCode": null,
            "telephony": [
              { … }
            ],
            "identity": [
              { … }
            ]
          },
          "address": {
            "city": "Some City",
            "state": "Some State",
            "countryCode": "GB",
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "postcodeOrZipCode": "S14 T4R",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          },
          "customerPartyId": ""
        }
      ],
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "entity": null
    }
  ]
}

Responses

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

Bodyapplication/json
instructingTreasuryIdstring, [ 6 .. 6 ]required

6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process. instructingTreasuryId is the same as the entity if payouts are being instructed by the ultimate consumer itself. Special characters are restricted.

entitystring or null, [ 6 .. 6 ]

6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process. This may be provided at the batch and/or payout level. If provided at both then the payout level entity overrides. Special characters are restricted. The value supplied is checked to be valid. It must also match the entity for which authorization has been supplied.

apiRequestReferencestring, [ 1 .. 35 ]required

Unique reference for the request supplied by you. This field in combination with instructingTreasuryId is used by our API for idempotency checks. Special characters are allowed.

Response
{
  "instructingTreasuryId": "000055",
  "entity": "000055",
  "apiRequestReference": "mustBeUnique12345"
}