How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldpay Parties API

Create and maintain parties.

Worldpay Parties API is one of 45 APIs that Worldpay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Parties. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 3.

Requests are made against 2 base URLs: https://try.access.worldpay.com, https://access.worldpay.com.

6 operations 4 paths 22 schemas 2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3
Base URL
https://access.worldpay.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Worldpay Parties API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Parties 6

Create and maintain parties.

POST
/parties
Create a party
createAccount 1 param body → 201400500503
GET
/parties
Browse parties
browseParties 6 params → 200400500503
GET
/parties/{partyId}
View a party
partyQuery 2 params → 200400500503
PUT
/parties/{partyId}
Update a party
updateParty 2 params body → 200400500503
POST
/parties/{partyId}/deactivation
Deactivate a party
deactivateParty 2 params body → 200400500
POST
/parties/{partyId}/activation
Reactivate a party
reactivateParty 2 params body → 200400500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Company (26 properties), Person (25 properties), SoleTrader (25 properties), PersonalDetailsImplForSoleTrader (20 properties). Each schema is shown below with its type and property counts.

PersonalDetailsForBeneficialOwner
object
14 properties 4 required
DeactivateParty
object
Object containing deactivation information.
4 properties 1 required
IdentityDocument
object
An identity document.
6 properties 3 required
BeneficialOwners
object
15 properties 3 required
RelationshipToBusiness
object
4 properties 3 required
SoleTrader
object
A party represents the overall party record of your beneficiary (seller, vendor, provider). You can use this to store information about the party, to perform e…
25 properties 5 required
Company
object
A party represents the overall party record of your beneficiary (seller, vendor, provider). You can use this to store information about the party, to perform e…
26 properties 5 required
CompanyDetails
object
Object containing details about a company. Required for company.
14 properties 4 required
TradingAddress
object
Object containing details about the address. Note: If isTradingAddressSameAsPrimary is set to true, do not provide tradingAddress. If isTradingAddressSameAsPri…
7 properties 3 required
BankAccount
object
16 properties 1 required
Address
object
Object containing details about the address.
7 properties 3 required
Pagination
object
Pagination information for browsing.
4 properties 2 required
Person
object
A party represents the overall party record of your beneficiary (seller, vendor, provider). You can use this to store information about the party, to perform e…
25 properties 5 required
ErrorResponseItem
object
6 properties
PersonalDetailsImplForPerson
object
14 properties 4 required
BrowsePartiesPage
object
A page of parties with pagination information.
2 properties 2 required
ReactivateParty
object
Object containing party reactivation information.
2 properties
PersonalDetailsImplForSoleTrader
object
20 properties 6 required
BalanceAccount
object
11 properties 1 required
Phone
object
Object containing phone information.
2 properties 2 required
ErrorResponse
object
6 properties
Merchant
object
An object that contains information about the merchant.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-parties-api-openapi.yml Raw ↑

Other APIs Worldpay publishes across the network.

Worldpay Tokens API
Worldpay Card Payouts API
Worldpay Account Payouts API
Worldpay FraudSight API
Worldpay 3DS API
Worldpay APMs API
Worldpay FX API
Worldpay Hosted Payment Pages API
Worldpay Events API
Worldpay Beneficiary Account Verifications API
Worldpay Split Payments API
Worldpay Statements API
Where this information came from

This is an independent, third-party profile of Worldpay Parties API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.