Batch Payouts

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


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

Batch payout request

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

Payout request body

{
  "RequesterDetails": {
    "InstructingTreasuryId": "000055",
    "entity": "000055",
    "ApiRequestReference": "testReference123"
  },
  "Payouts": [
    {
      "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"
          }
        }
      ]
    },
    {
      "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"
          }
        }
      ]
    },
    {
      "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"
          }
        }
      ]
    },
    {
      "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"
          }
        }
      ]
    },
    {
      "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"
          }
        }
      ]
    },
    {
      "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"
          }
        }
      ]
    },
    {
      "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"
          }
        }
      ]
    },
    {
      "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": "6135539e-45e7-4a4a-a74d-311c67a9c670",
      "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"
          }
        }
      ]
    },
    {
      "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 for appropriate fields, as well as preset values for specific fields are listed in the appendix.

Batch level parameters

Field NameDescriptionData Type/FormatRequired?Min-Max LengthValidation Criteria
RequesterDetails.instructingTreasuryIdUnique ID given to you during the onboarding process. instructingTreasuryId will be same as the entity if the payment request is being instructed by the ultimate consumer itself.AN6-6Special characters are restricted.
RequesterDetails.entityMerchant Domain making payout. This may be provided at the batch and/or payout level. If provided at both then the payout level entity overrides.ANConditional6-6Special characters are restricted. ID supplied is checked to be valid. It must also be authorised by the token provided in the Authorization header.
RequesterDetails.notificationUrlURL of where WTS notifications are sent. This field will be available for use as part of the future enhancements to the Account Payouts API.AN1-250Special characters are allowed. For the full list please see the appendix.
RequesterDetails.apiRequestReferenceUnique reference for the request. This field along with instructingTreasuryId is used by our API for idempotency checks.String1-35Special characters are allowed. For the full list please see the appendix.

Payout level parameters

Field NameDescriptionData Type/FormatRequired?Min-Max LengthValidation Criteria
entityMerchant Domain making payout. This may be provided at the batch and/or payout level. If provided at both then the payout level entity overrides.ANConditional6-6
transactionReferenceMerchant's unique reference for the payment request.AN6-50Special characters are allowed.
countryCodeCountr code of payout destination.A2[ISO 3166-1 Alpha-2 code](/products/access/reference/useful-tables#iso-country-codes
sourceCurrencySource currency for the payout.A3ISO 4217

Valid currency codes.
sourceAmountSource currency amount (if target amount is not stated, this amount is used). Must be a positive value up to 2 decimal places.NConditional1-10Must be a positive value up to 2 decimal places.
targetCurrencyTarget currency sent in payout (if different to source currency FX is applied).A3-3ISO 4217

Valid currency codes.
targetAmountTarget currency amount (if source amount is not specified, this amount is used).NConditional1-10Must be a positive value up to 2 decimal places.
narrativeReference that may appear on beneficiary statements.String6-50Special characters are allowed.
purposeOfPaymentCodeThe code that represents the purpose of payment.
Note
This is mandatory for some payout routes - please check country specific requirements.
AValueFor the full list of values see the appendix.
fastPaymentFlag for a fast payment - If value is provided, it must always be 'Y'.AValueThe value supplied for the field must be "Y", blank or null. Else the field can be not provided.
purposeOfPaymentNarrativeDescription for purpose of payment.String1-35Special characters are allowed.
transactionTypeCodeType of transaction code (for example 'TT04' that refers to 'Business to Customer'). (i) This field is available for use as part of the future enhancements to the Account Payouts API in 2023. (j) Mandatory for some payout routes - please check country specific requirements.ANValueFor the full list of values see the appendix.
channelPreferable channel of the payment (for example 'WIRE').AValueFor the full list of values see the appendix.
quoteIdID of the FX quote for the payment request. This must be a valid, active quote which is for the same source and target currencies as the payout request. It must have valid intent of "FORWARD FX" or "PAYOUT".String
scheduleDateScheduled date of the payment request. This field is available for use as part of the future enhancements to the Account Payouts API in 2023date10-10Must be a Gregorian calendar date with ISO format 8601 YYYY-MM-DD
expandableKeyValuePairsJSON object of key-value pairs. Additional data in the form of key value pairs. The keys and values that might be required to process a Push to Account payment to a specific destination will be communicated during the onboarding process.ANDuplicate key names are not allowed
bankDetails.beneficiaryAccountTypeCodeType of account code (for example 'AC01' that refers to 'Checking').ANValueFor the full list of allowed values see the appendix.
bankDetails.beneficiaryAccountNumberBeneficiary bank Account Number. Either Account Number or IBAN must be provided.StringConditional1-35Special characters are allowed
bankDetails.ibanBeneficiary IBAN. Either Account Number or IBAN must e provided.ANConditional1-34
bankDetails.bankCodeBeneficiary bank account bank code.String1-35Special characters are allowed.
bankDetails.branchCodeBeneficiary bank account branch code.String1-35Special characters are allowed.
bankDetails.swiftBicBeneficiary bank account SWIFT/BICAN8 or 11
bankDetails.bankNameBeneficiary bank nameString1-35Special characters are allowed.
bankDetails.address.streetBeneficiary bank address: streetString1-35Special characters are allowed.
bankDetails.address.additionalAddressLineBeneficiary bank Additional Address Line.String1-35Special characters are allowed
bankDetails.address.cityBeneficiary bank address: CityString1-35Special characters are allowed
bankDetails.address.stateBeneficiary bank address: StateString2-35Special characters are allowed
bankDetails.address.postcodeOrZipCodeBeneficiary bank address: Postcode/ZipCodeString1-35Special characters are allowed
bankDetails.address.countryCodeBeneficiary bank address: countryCodeA2-2ISO 3166-1 alpha-2 code
parties.partyIdId of the party for the payment request. This field will be available for use as part of the future enhancements to the Account Payouts API in 2023.String36-36 (Guid with Hyphens only){{$guid}} Example: 1E016F5E-9D4A-49E7-B44C-A4C8AAE8290D
parties.customerPartyIdThe ID of the remitter: Domain ID, Account Number, Tax ID, BIC, Internal Customer ID or any other numerical or alphanumerical unique identifier of the customer where the payment request has originated. This field will be available for use as part of the future enhancements to the Account Payouts API in 2023AN1-35Special characters are restricted. Value supplied must be in the format of 1-35 alphanumeric characters.
parties.partyTypeCodeParty type code (for example 'PT03' that refers to beneficiary)ANValueFor the full list of allowed values see the appendix.
parties.personalDetails.typeCodeEntity description code for the party (for example 'PD02' that refers to 'Individual').ANValueFor the full list of allowed values see the appendix. This field is mandatory if the partyTypeCode supplied is that for a beneficiary.
parties.personalDetails.titleCodeTitle code for the Individual (applicable when party entity type is "Individual"). Must not be provided when type is not "Individual".ANConditionalValueFor the full list of allowed values see the appendix.
parties.personalDetails.companyNameName of the organization if not an individual. Mandatory where party entity type is "Institution", "Government" or "Company". Must not be provided when type is 'Individual'.StringConditional1-140Special characters are allowed.
parties.personalDetails.firstNameFirst name of the party. Mandatory where party entity type is "Individual".ANConditional1-50Special characters are allowed.
See formatting rules
parties.personalDetails.middleNameMiddle name of the party (applicable when party entity type is "Individual").AN1-50Special characters are allowed.
See formatting rules
parties.personalDetails.lastNameLast name of the party. Mandatory where party entity type is "Individual".ANConditional1-50Special characters are allowed.
See formatting rules
parties.personalDetails.dateOfBirthDate of birth or date of incorporation of the party.Date10-10Must be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD.
parties.personalDetails.emailE-mail address of the party. This field will be available for use as part of the future enhancements to the Account Payouts API in 2023StringA valid e-mail address format
parties.personalDetails.telephony.phoneNumberPhone number of the party. Mandatory if 'prefix' has been provided.NConditional1-20Special characters are restricted.
parties.personalDetails.telephony.prefixPhone dialling country code of the party. Mandatory if 'phoneNumber' has been provided.NConditional1-3Special characters are restricted.

International country calling code following ITU-T standard.

Must be 1-3 digits
e.g. "44" or "420"
parties.personalDetails.identity.identityTypeCodeType of identification. Mandatory if 'identity number' is populated.ANConditionalValueFor the full list of allowed values see the appendix.
parties.personalDetails.identity.identityNumberIdentification number that is presented in the identification type. Mandatory if "IdentityTypeCode" is populated.StringConditional1-35Special characters are allowed.
parties.personalDetails.identity.issuingCountryCountry of identification type origin. Mandatory if "identityTypeCode"/"identityNumber" is populated.AConditional2-2ISO 3166-1 Alpha-2 code
parties.personalDetails.identity.issuingInstitutionIssuing institution that provided identification type.String1-35Special characters are allowed. Cannot be provided if the conditional fields in the identity section are missing.
parties.personalDetails.identity.startDateIdentification type start date.Date10-10Must be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD. Cannot be provided if conditional fields in the identity section are missing.
parties.personalDetails.identity.endDateIdentification type end date.Date10-10Must be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD. Cannot be provided if conditional fields in the identity section are missing.
parties.address.addressTypeCodeType of party address code (for example 'AD02' that refers to 'Business'). This field will be available for use as part of the future enhancements to the Account Payouts API in 2023.ANValueFor the full list of allowed values see the appendix.
parties.address.streetParty address: streetString1-35Special characters are allowed.
parties.address.additionalAddressLineParty Additional Address Line.String1-35Special characters are allowed.
parties.address.cityParty address: CityString1-35Special characters are allowed.
parties.address.stateParty address: StateString2-35Special characters are allowed.
parties.address.postcodeOrZipCodeParty address: Postcode/ZipCodeString1-35Special characters are allowed.
parties.address.countryCodeParty address: countryCodeA2-2ISO 3166-1 Alpha-2 code
parties.address.residentialStatusCodeType of residency code (for example 'RS01' that refers to 'Resident). This field will be available for use as part of the future enhancements to the Account Payouts API in 2023.ANValueFor the full list of allowed values see the appendix.

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"
    }
]

Error response example

{
    "errors": {
        "callerId": [
            "CallerId is mandatory"
        ]
    },
    "httpStatusCode": 400,
    "customCode": "SPAB01",
    "message": "There was an error in the request"
}

Error response codes

General

HTTP codeCustom CodeMessageScenario
202N/AN/APayment request accepted
200N/AN/APayment request already submitted and accepted
400SPAB01There was an error in the requestCaller ID exceeds 100 characters limit
400SPAV01An API version is required, but was not specified.Version not specified or incorrect / Provided versions are conflicting
401SPAU02UnauthorizedThe token has expired
401SPAU03UnauthorizedThe edge token is not trusted
401SPAU14UnauthorizedUnauthorized request
401SPAE11XUnauthorized requestUnauthorized request
404SPAN16Unable to find external consumer dataConsumer with subject-domain combination not found
500SPAU04Unexpected issueUnexpected issue. Please try again
401SPAU07AUnauthorized requestToken is empty
401SPAU06AUnauthorized requestToken validation failed
401SPAU06AUnauthorized requestToken has expired
401SPAU10
SPAU07B
Authentication failedToken validation failed
500SPAE12
SPAE11
SPAE11A
SPAE11B
SPAE11C
SPAE11D
SPAE11E
Unexpected Issue. Please try againInternal Server Error
415N/AUnsupported Media TypeInvalid Content Type Value
403SPAF07Consumer isn't allowed to instruct payoutsConsumer isn't allowed to instruct payout using the entitlements that were provided in the token.
403SPAF18Authorisation failed for this domainConsumer isn't allowed to instruct payout using the entitlements that were provided in the token.
422N/AQuote validation failedThe quote supplied has currencies which does not match those supplied in the token, or has an intent which is other than "PAYOUT" or "FORWARD FX".
422N/AQuote ExpiredThe quote supplied is expired.
422N/AContract not ActiveThe quote supplied cannot yet be used. This will only be the case for quotes with intent "FORWARD FX".
Note

In the event of 401-500 range HTTP code error response please contact your Implementation Manager.

Schema Validation Responses

All schema validation responses have the same format of httpStatusCode, customCode and message. Response code and message values differ depending on the validation error.

HTTP codeCustom codeExample messageScenario
400SPAB05The length of 'Company Name' must be 140 characters or fewer. You entered 475 characters.Property length is incorrect ('or fewer' scenario).
400SPAB05'Unique Payout Id' must be between 6 and 50 characters. You entered 2 characters.Property length is incorrect ('between' scenario).
400SPAB05'Issuing Country' is not in the correct format.Property is not in a correct format.
400SPAB05sourceAmount must be a positive value.Amount is not a positive value.
400SPAB05Only one of the fields targetAmount/sourceAmount must be provided.Both source/target amounts have been given.
400SPAB05The 'Fast Payment' field can only be 'Y' or blank.Value invalid.
400SPAB05transactionTypeCode field does not allow free-format text. One of the following values only to be used in Transaction Type: TT01,TT02,TT03,TT04.Value invalid.
400SPAB05One of the following values only to be used in TypeCode: PD01, PD02, PD03, PD04, PD99.Value invalid.
400SPAB05'Full Name' is not in the correct format.Name Regex validation failed.
400SPAB05titleCode is not allowed when the typeCode is set to "PD01/PD03/PD04".Property restricted with this type of customer.
400SPAB05companyName must not be blank when typeCode is set to "PD01".Property restricted with this is type of customer. This applies if Individual data is provided but type is set to Company, Government, or Institution
400SPAB05companyName is not allowed when the type is set to Individual.Property restricted with this is type of customer. This applies if individual data is provided but typeCode is set to "PD01, PD04 or PD02". This applies to parties which are beneficiary & remitter (partyTypeCode PT01 and PT03).
400SPAB05DateOfBirth is invalid. Please use Gregorian calendar dates with ISO 8601 format YYYY-MM-DD.Invalid Date format.
400SPAB05'Bank name' must not be empty.Mandatory section/field is missing.
400SPAB05phoneNumber must consist of numbers only.The property can be only Numerical.
400SPAB05customerPartyId must be between 1-35 characters length.**Property length is incorrect (between scenario with no indication of provided value).
400SPAB05'IBAN' is not in the correct format.Invalid format of the property.
400SPAB05IBAN or 'Account Number' Must be present.Both IBAN/Account Number missing
400SPAB05prefix must be provided if the phoneNumber field is populated.Condition of linked fields not met.
400SPAB05identityTypeCode must be provided if any of the other Identity block fields are populated.Condition of linked fields not met. If any of the identity block fields are given then all mandatory identity BLOCK fields should be provided. If there is no intention of providing identity fields then the whole BLOCK should be removed from the payload.
400SPAB05When expandableKeyValuePairs are provided.There must not be duplicate key names.
400SPAB05When expandableKeyValuePairs are provided but property value is not a JSON object containing key value pairs.Property value if provided must be a JSON object containing key value pairs.