Make a batch payout

APIs/Account Payouts/Batch payout/

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:"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

payoutsArray of objects or null, [ 1 .. 500 ]

Holds information about the individual payouts.

notificationUrlstring or null

Currently not in use.

{
  "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/json

entitystring or null

idempotencyKeystring or null

Response

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