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.

WP-Api-Versionstring, (date)required

The API version.

Example:2025-01-01

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/parties/{partyId}/payoutInstruments/{payoutInstrumentId}' \
  -H 'WP-Api-Version: 2025-01-01'

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

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.

branchCodestring

Response

Get a payoutInstrument for a party of person (modular)

{
  "payoutInstrumentReference": "personalCheckingAccount",
  "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": "23198765",
  "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"
}