Last Updated: 14 May 2025 | Change Log

Batch Payouts

Execute a batch of Account Payouts to nominated beneficiary bank accounts as per individual payouts in the batch.


Authorization: {your_credentials}
Content-Type: application/vnd.worldpay.account-payouts-v2+json

Batch payout request

POST https://try.access.worldpay.com/payouts/accounts/batch

Payout request body

{
  "RequesterDetails": {
    "InstructingTreasuryId": "000055",
    "entity": "000055",
    "ApiRequestReference": "testReference123"
  },
  "Payouts": [
    {
      "entity": "000055",
      "transactionReference": "202401",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "WIRE",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "expandableKeyValuePairs": {
        "RemitterSourceOfIncome": "salary",
        "BeneficiaryNationality": "British"
      },
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202402",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "WIRE",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202403",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "ACH",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202404",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "FP",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202405",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "SEPA",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202406",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "LOCAL",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202407",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "INTERNAL",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202408",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "WIRE",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    },
    {
      "entity": "000055",
      "transactionReference": "202409",
      "countryCode": "GB",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "narrative": "Ref: 123456",
      "purposeOfPaymentCode": "WPPAYR",
      "fastPayment": "Y",
      "purposeOfPaymentNarrative": "Salary payment",
      "transactionTypeCode": "TT04",
      "channel": "WIRE",
      "quoteId": "",
      "scheduleDate": "2022-12-31",
      "bankDetails": {
        "beneficiaryAccountTypeCode": "AC01",
        "beneficiaryAccountNumber": "12345677",
        "iban": "GB29NWBK60161331926819",
        "branchCode": "300",
        "bankCode": "404433",
        "swiftBic": "BUKBGB22",
        "bankName": "Bank of Sale",
        "address": {
          "street": "3 Rock Lane",
          "additionalAddressLine": "An Area",
          "city": "Sale",
          "state": "Cheshire",
          "postCodeOrZipCode": "P55 T1B",
          "countryCode": "GB"
        }
      },
      "parties": [
        {
          "partyId": "6135539e-45e7-4a4a-a74d-311c67a9c670",
          "customerPartyId": "customer123",
          "partyTypeCode": "PT03",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "John",
            "middleName": "Johno",
            "lastName": "Johnson",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        },
        {
          "partyId": "",
          "customerPartyId": "",
          "partyTypeCode": "PT01",
          "personalDetails": {
            "typeCode": "PD02",
            "titleCode": "TI01",
            "firstName": "Company",
            "middleName": "Name",
            "lastName": "Ltd",
            "dateOfBirth": "1993-12-31",
            "email": "john@domain.com",
            "telephony": [
              {
                "phoneNumber": "01375841159",
                "prefix": "44"
              }
            ],
            "identity": [
              {
                "identityTypeCode": "ID01",
                "identityNumber": "123456789",
                "issuingInstitution": "IPS",
                "issuingCountry": "GB",
                "startDate": "2013-05-22",
                "endDate": "2014-05-21"
              }
            ]
          },
          "address": {
            "street": "1 Some Street",
            "additionalAddressLine": "Some Neighborhood",
            "city": "Some City",
            "state": "Some State",
            "postCodeOrZipCode": "S14 T4R",
            "countryCode": "GB",
            "addressTypeCode": "AD01",
            "residentialStatusCode": "RS01"
          }
        }
      ]
    }
  ]
}

Parameters

Permitted special characters as well as preset values for specific fields are listed in the appendix.

requesterDetailsobject(WP.FXT.SinglePayoutApi.Domain.PayoutBatch.V1.Models.RequesterDetails)
payoutsArray of objects or null(WP.FXT.SinglePayoutApi.Domain.PayoutBatch.V1.Models.BatchPayout)

Response:

Successful response example

[
    {
        "transactionReference": "202401",
        "ubr": "PN000CYV"
    },
    {
        "transactionReference": "202402",
        "ubr": "PN000CYW"
    },
    {
        "transactionReference": "202403",
        "ubr": "PN000CYX"
    },
    {
        "transactionReference": "202404",
        "ubr": "PN000CYY"
    },
    {
        "transactionReference": "202405",
        "ubr": "PN000CYZ"
    },
    {
        "transactionReference": "202406",
        "ubr": "PN000CY2"
    },
    {
        "transactionReference": "202407",
        "ubr": "PN000CY3"
    },
    {
        "transactionReference": "202408",
        "ubr": "PN000CY4"
    },
    {
        "transactionReference": "202409",
        "ubr": "PN000CY5"
    }
]

Successful response schema

ubrstring

Unique payout request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters, e.g. PZ000N65. Five numbers, a letter and finally two/four further numbers

apiRequestReferencestring

Unique reference from the request.

instructingTreasuryIdstring

Unique ID given during the onboarding process.

See our full schema in our API reference.

Schema validation response

You can view a list of potential schema validation responses in our appendix.