Skip to content
APIs/Account Payouts/Single Payout

Single Payout

Operations

Make a single 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
requesterobject
countryCodestring, [ 2 .. 2 ]required

ISO 3166-1 Alpha-2 country code of the payout destination.

expandableKeyValuePairsobject or null

JSON object of key-value pairs used to supply additional data. The keys and values that you might need to process an account payout to a specific destination, are communicated during the onboarding process. Duplicate key names are not allowed. Invalid keys.

channelstring or null

Preferable channel for the payment. For the full list of allowed values see the appendix. This field is currently not used.

quoteIdstring or null

ID of the FX quote for the 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".

scheduleDatestring or null, [ 10 .. 10 ]

Scheduled date of the payout request. Must be a Gregorian calendar date with ISO format 8601 YYYY-MM-DD. This field is currently not used.

bankDetailsobject

The bank details of the beneficiary.

Note: View our bank coverage guide for country specific requirements.

transactionReferencestring, [ 6 .. 50 ]required

Reference for the payout request provided by you. We recommend you specify a value which is unique across all of your payouts to ensure you receive the right data throughout the payout lifecycle. Special characters are allowed.

sourceCurrencystring, [ 3 .. 3 ]required

Source currency code for the payout (if different to targetCurrency, Foreign Exchange (FX) is applied).

sourceAmountnumber or null, (double), [ 1 .. 10 ]

Source amount (if targetAmount is not stated, this amount is used). Must be a positive value up to 2 decimal places. FX rate of the payout is applied by us, therefore, only one of the sourceAmount or targetAmount is required in your request.

targetCurrencystring, [ 3 .. 3 ]required

Target ISO 4217 alpha-3 currency codes for the payout (if different to sourceCurrency, Foreign Exchange (FX) is applied).

targetAmountnumber or null, (double), [ 1 .. 10 ]

Target amount (if sourceAmount is not specified, this amount is used). Must be a positive value up to 2 decimal places. FX rate of the payout is applied by us, therefore, only one of the sourceAmount or targetAmount is required in your request.

partiesArray of objects or null

Details of the party.

Note: View our bank coverage guide for country specific requirements.

narrativestring or null, [ 6 .. 50 ]

Reference that may appear on beneficiary statements. Special characters are allowed.

purposeOfPaymentCodestring

The code that represents the purpose of the payment.

Note: This is mandatory for some payout routes. View our bank coverage guide for country specific requirements.

For the full list of allowed values see the appendix.

purposeOfPaymentNarrativestring, [ 1 .. 35 ]

Description for purpose of payment.

Note: This is mandatory for some payout routes. View our bank coverage guide for country specific requirements.

Special characters are allowed.

transactionTypeCodestringrequired

Type of transaction code. This is mandatory for some payout routes - please check country specific requirements. See the appendix for full details.

Enum:"TT01""TT02""TT03""TT04""TT05""TT08""TT06""TT07""TT09""TT10"
{
  "requester": {
    "instructingTreasuryId": "000055",
    "entity": "000055",
    "apiRequestReference": "mustBeUnique12345",
    "notificationUrl": null
  },
  "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": [
          {
            "phoneNumber": "01375841159",
            "prefix": "44"
          }
        ],
        "identity": [
          {
            "issuingInstitution": "IPS",
            "issuingCountry": "GB",
            "identityTypeCode": "ID01",
            "startDate": "2013-05-22",
            "endDate": "2014-05-21",
            "identityNumber": "123456789"
          }
        ]
      },
      "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": [
          {
            "phoneNumber": "01375841159",
            "prefix": "44"
          }
        ],
        "identity": [
          {
            "issuingInstitution": "IPS",
            "issuingCountry": "GB",
            "identityTypeCode": "ID01",
            "startDate": "2013-05-22",
            "endDate": "2014-05-21",
            "identityNumber": "123456789"
          }
        ]
      },
      "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"
}

Responses

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

Bodyapplication/json
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.

Response
{
  "ubr": "PZ000EC4",
  "apiRequestReference": "mustBeUnique12345",
  "instructingTreasuryId": "001948"
}