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.
http://access.worldpay.com/
http://try.access.worldpay.com/
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
Object containing details about the address.
The address.
Must consist of at least two letters, two words, and one number.
The country code specified in ISO 3166-1 Alpha-2 code format.
http://access.worldpay.com/parties/{partyId}/payoutInstruments
http://try.access.worldpay.com/parties/{partyId}/payoutInstruments
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" } }
Created
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
The date and time the payoutInstrument
was created, as an ISO 8601 zoned date time.
The date and time the payoutInstrument
was updated, as an ISO 8601 zoned date time.
Object containing details about the address.
The address.
Must consist of at least two letters, two words, and one number.
The country code specified in ISO 3166-1 Alpha-2 code format.
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" }
http://access.worldpay.com/parties/{partyId}/payoutInstruments/{payoutInstrumentId}
http://try.access.worldpay.com/parties/{partyId}/payoutInstruments/{payoutInstrumentId}
No request payload
OK
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
The date and time the payoutInstrument
was created, as an ISO 8601 zoned date time.
The date and time the payoutInstrument
was updated, as an ISO 8601 zoned date time.
Object containing details about the address.
The address.
Must consist of at least two letters, two words, and one number.
The country code specified in ISO 3166-1 Alpha-2 code format.
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" }
A unique identifier for the party generated by us. This is sent in the response of your party creation call.
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
Object containing details about the address.
The address.
Must consist of at least two letters, two words, and one number.
The country code specified in ISO 3166-1 Alpha-2 code format.
http://access.worldpay.com/parties/{partyId}/payoutInstruments/{payoutInstrumentId}
http://try.access.worldpay.com/parties/{partyId}/payoutInstruments/{payoutInstrumentId}
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" } }
OK
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.
An ID generated by us to identify a payout instrument. You receive this in the response after successfully creating a payout instrument.
The currency in ISO 4217 currency format.
The date and time the payoutInstrument
was created, as an ISO 8601 zoned date time.
The date and time the payoutInstrument
was updated, as an ISO 8601 zoned date time.
Object containing details about the address.
The address.
Must consist of at least two letters, two words, and one number.
The country code specified in ISO 3166-1 Alpha-2 code format.
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" }