APIs
/
Parties
/
Payout instruments
/
View a payout instrument

Parties (2025-01-01)

Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.

Authentication

Set your headers

Authorization: {your_credentials}
WP-Api-Version: 2025-01-01

Replace {your_credentials} with your base64-encoded Basic Auth username and password.

DNS Whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting.

API Collection

A full set of API examples based on different scenarios.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Worldpay

Languages
Servers
Live

http://access.worldpay.com/

Try

http://try.access.worldpay.com/

Parties

Create and maintain parties.

Operations

Payout instruments

Create and maintain payout instruments.

Operations

Create a payout instrument

Request

Security
basicAuth
Path
partyIdstringrequired

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.

Example: "parOk0YlPtQogrqQdz7_fKXs0"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject

Object containing details about the address.

address1string[ 2 .. 35 ] charactersrequired

The address.

Must consist of at least two letters, two words, and one number.

Example: "1847 Kingsbury Court"
address2string[ 2 .. 35 ] characters

Line two of the address.

Example: "Unit 42"
citystring[ 1 .. 35 ] charactersrequired

The city of this address.

Example: "London"
statestring[ 2 .. 35 ] characters

The state of this address.

Example: "Greater London"
countryCodestring= 2 charactersrequired

The country code specified in ISO 3166-1 Alpha-2 code format.

Example: "GB"
postalCodestring[ 1 .. 20 ] charactersrequired

The postal code of this address.

Example: "NW9 0RR"
typestring

Identifies the type of this address.

Enum"home""business""poBox""other"
Example: "home"
branchCodestring
application/json

Create a payoutInstrument for a party of person (modular)

{
  "accountHolderName": "Case H. Mitchell",
  "payoutInstrumentType": "bankAccount",
  "swiftBic": "BUKBGB22",
  "bankCode": "045110",
  "branchCode": "Barclays Branch",
  "accountNumber": "2319876543210",
  "accountType": "checking",
  "iban": "GB892019000123456789",
  "bankName": "Metro Bank",
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "currency": "EUR",
  "address": {
    "address1": "17 Neo-London Financial Tower",
    "address2": "Suite 1288",
    "type": "business",
    "city": "London",
    "countryCode": "GB",
    "postalCode": "EC1A 1BB"
  }
}

Responses

Created

Bodyapplication/json
One of:
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.

Example: "parOk0YlPtQogrqQdz7_fKXs0"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
dateTimeCreatedstringread-only

The date and time the payoutInstrument was created, as an ISO 8601 zoned date time.

dateTimeUpdatedstringread-only

The date and time the payoutInstrument was updated, as an ISO 8601 zoned date time.

versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject

Object containing details about the address.

address1string[ 2 .. 35 ] charactersrequired

The address.

Must consist of at least two letters, two words, and one number.

Example: "1847 Kingsbury Court"
address2string[ 2 .. 35 ] characters

Line two of the address.

Example: "Unit 42"
citystring[ 1 .. 35 ] charactersrequired

The city of this address.

Example: "London"
statestring[ 2 .. 35 ] characters

The state of this address.

Example: "Greater London"
countryCodestring= 2 charactersrequired

The country code specified in ISO 3166-1 Alpha-2 code format.

Example: "GB"
postalCodestring[ 1 .. 20 ] charactersrequired

The postal code of this address.

Example: "NW9 0RR"
typestring

Identifies the type of this address.

Enum"home""business""poBox""other"
Example: "home"
branchCodestring
Response
application/json

PayoutInstrument for a person (modular)

{
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "payoutInstrumentId": "parF4BlVTN_zIcADcyBpXK6J0",
  "payoutInstrumentType": "bankAccount",
  "currency": "EUR",
  "dateTimeCreated": "2025-04-07T20:42:24.408Z",
  "version": 0,
  "accountHolderName": "Case H. Mitchell",
  "swiftBic": "BUKBGB22",
  "bankCode": "045110",
  "accountNumber": "2319876543210",
  "accountType": "checking",
  "iban": "GB892019000123456789",
  "bankName": "Metro Bank",
  "address": {
    "address1": "17 Neo-London Financial Tower",
    "address2": "Suite 1288",
    "city": "London",
    "countryCode": "GB",
    "postalCode": "EC1A 1BB",
    "type": "business"
  },
  "branchCode": "Barclays Branch"
}

View a payout instrument

Request

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

payoutInstrumentIdstring= 25 characterspar.*0$required

A unique identifier for the payoutInstrument generated by us. This is sent in the response of your payoutInstrument creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
No request payload

Responses

OK

Bodyapplication/json
One of:
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.

Example: "parOk0YlPtQogrqQdz7_fKXs0"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
dateTimeCreatedstringread-only

The date and time the payoutInstrument was created, as an ISO 8601 zoned date time.

dateTimeUpdatedstringread-only

The date and time the payoutInstrument was updated, as an ISO 8601 zoned date time.

versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject

Object containing details about the address.

address1string[ 2 .. 35 ] charactersrequired

The address.

Must consist of at least two letters, two words, and one number.

Example: "1847 Kingsbury Court"
address2string[ 2 .. 35 ] characters

Line two of the address.

Example: "Unit 42"
citystring[ 1 .. 35 ] charactersrequired

The city of this address.

Example: "London"
statestring[ 2 .. 35 ] characters

The state of this address.

Example: "Greater London"
countryCodestring= 2 charactersrequired

The country code specified in ISO 3166-1 Alpha-2 code format.

Example: "GB"
postalCodestring[ 1 .. 20 ] charactersrequired

The postal code of this address.

Example: "NW9 0RR"
typestring

Identifies the type of this address.

Enum"home""business""poBox""other"
Example: "home"
branchCodestring
Response
application/json

Get a payoutInstrument for a party of person (modular)

{
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "payoutInstrumentId": "parVID57-ep4PqX6J-25AkZk0",
  "payoutInstrumentType": "bankAccount",
  "currency": "EUR",
  "dateTimeCreated": "2025-04-07T20:48:00.227Z",
  "version": 0,
  "accountHolderName": "Case H. Mitchell",
  "swiftBic": "BUKBGB22",
  "bankCode": "045110",
  "accountNumber": "2319876543210",
  "accountType": "checking",
  "iban": "GB892019000123456789",
  "bankName": "Metro Bank",
  "address": {
    "address1": "17 Neo-London Financial Tower",
    "address2": "Suite 1288",
    "city": "London",
    "countryCode": "GB",
    "postalCode": "EC1A 1BB",
    "type": "business"
  },
  "branchCode": "Barclays Branch"
}

Update a payout instrument

Request

Security
basicAuth
Path
partyIdstring= 25 characters^par[a-zA-Z0-9-_]*0$required

A unique identifier for the party generated by us. This is sent in the response of your party creation call.

payoutInstrumentIdstring= 25 characterspar.*0$required

A unique identifier for the payoutInstrument generated by us. This is sent in the response of your payoutInstrument creation call.

Headers
WP-Api-Versionstring(date)required

The API version.

Example: 2025-01-01
Bodyapplication/jsonrequired
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.

Example: "parOk0YlPtQogrqQdz7_fKXs0"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject

Object containing details about the address.

address1string[ 2 .. 35 ] charactersrequired

The address.

Must consist of at least two letters, two words, and one number.

Example: "1847 Kingsbury Court"
address2string[ 2 .. 35 ] characters

Line two of the address.

Example: "Unit 42"
citystring[ 1 .. 35 ] charactersrequired

The city of this address.

Example: "London"
statestring[ 2 .. 35 ] characters

The state of this address.

Example: "Greater London"
countryCodestring= 2 charactersrequired

The country code specified in ISO 3166-1 Alpha-2 code format.

Example: "GB"
postalCodestring[ 1 .. 20 ] charactersrequired

The postal code of this address.

Example: "NW9 0RR"
typestring

Identifies the type of this address.

Enum"home""business""poBox""other"
Example: "home"
branchCodestring
application/json

Update payout instrument for existing party of a company (modular)

{
  "accountHolderName": "Tessier-Ashpool Systems Ltd.",
  "payoutInstrumentType": "bankAccount",
  "swiftBic": "FSFCUS33",
  "bankCode": "045110",
  "branchCode": "Muswell Hill Branch",
  "accountNumber": "2276581",
  "accountType": "savings",
  "iban": "GB33TASS12345678901234",
  "bankName": "Freeside Financial Corporation",
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "currency": "EUR",
  "address": {
    "address1": "9105 Villa Straylight",
    "address2": "Freeside",
    "type": "business",
    "city": "York",
    "state": "NA",
    "countryCode": "GB",
    "postalCode": "L502 MK54"
  }
}

Responses

OK

Bodyapplication/json
One of:
payoutInstrumentReferencestring[ 3 .. 64 ] characters^[A-Za-z0-9\-_ ]*$

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. Use this to direct payouts to the relevant beneficiary. This must be unique within an entity.

Example: "MyPayoutInstrument1"
payoutInstrumentIdstring= 25 characters^par[a-zA-Z0-9-_]*0$

An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.

Example: "parOk0YlPtQogrqQdz7_fKXs0"
payoutInstrumentTypestring

The type of the payout instrument.

Enum"bankAccount""wallet""card"
currencystring= 3 characters^[A-Z]*$required

The currency in ISO 4217 currency format.

Example: "GBP"
dateTimeCreatedstringread-only

The date and time the payoutInstrument was created, as an ISO 8601 zoned date time.

dateTimeUpdatedstringread-only

The date and time the payoutInstrument was updated, as an ISO 8601 zoned date time.

versioninteger(int32)
accountHolderNamestring
swiftBicstring
bankCodestring

The bankCode must be exactly 6 digits.

Example: "184758"
accountNumberstring
accountTypestring
Enum"checking""savings""moneyMarket""certificateOfDeposit""vista""other"
ibanstring
bankNamestring
addressobject

Object containing details about the address.

address1string[ 2 .. 35 ] charactersrequired

The address.

Must consist of at least two letters, two words, and one number.

Example: "1847 Kingsbury Court"
address2string[ 2 .. 35 ] characters

Line two of the address.

Example: "Unit 42"
citystring[ 1 .. 35 ] charactersrequired

The city of this address.

Example: "London"
statestring[ 2 .. 35 ] characters

The state of this address.

Example: "Greater London"
countryCodestring= 2 charactersrequired

The country code specified in ISO 3166-1 Alpha-2 code format.

Example: "GB"
postalCodestring[ 1 .. 20 ] charactersrequired

The postal code of this address.

Example: "NW9 0RR"
typestring

Identifies the type of this address.

Enum"home""business""poBox""other"
Example: "home"
branchCodestring
Response
application/json

Update payout instrument for existing party of a company (modular)

{
  "payoutInstrumentReference": "MyPayoutInstrument1",
  "payoutInstrumentId": "parWm7eF6Dfwry4EYQdpXSSB0",
  "payoutInstrumentType": "bankAccount",
  "currency": "EUR",
  "dateTimeCreated": "2025-04-22T19:24:07.680Z",
  "dateTimeUpdated": "2025-04-22T19:24:11.462Z",
  "version": 2,
  "accountHolderName": "Tessier-Ashpool Systems Ltd.",
  "swiftBic": "FSFCUS33",
  "bankCode": "045110",
  "accountNumber": "2276581",
  "accountType": "savings",
  "iban": "GB33TASS12345678901234",
  "bankName": "Freeside Financial Corporation",
  "address": {
    "address1": "9105 Villa Straylight",
    "address2": "Freeside",
    "city": "York",
    "state": "NA",
    "countryCode": "GB",
    "postalCode": "L502 MK54",
    "type": "business"
  },
  "branchCode": "Muswell Hill Branch"
}

Balance accounts

Create and maintain balance accounts.

Operations

Beneficial owners

Create and maintain beneficial owners.

Operations

Identity Verification

Enable Identity Verification check on a party.

Operations