Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldpay Payout instruments API

Create and maintain payout instruments.

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

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

This API exposes 3 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 3.

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

3 operations 2 paths 7 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 3

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

Payout instruments 3

Create and maintain payout instruments.

POST
/parties/{partyId}/payoutInstruments
Create a payout instrument
createPayoutInstruments 2 params body → 201400500503
GET
/parties/{partyId}/payoutInstruments/{payoutInstrumentId}
View a payout instrument
getPayoutInstrument 3 params → 200400500503
PUT
/parties/{partyId}/payoutInstruments/{payoutInstrumentId}
Update a payout instrument
updatePayoutInstruments 3 params body → 200400500503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are BankAccount (16 properties), Card (9 properties), Address (7 properties), Wallet (7 properties). Each schema is shown below with its type and property counts.

Wallet
object
7 properties 1 required
ErrorResponseItem
object
6 properties
BankAccount
object
16 properties 1 required
ErrorResponse
object
6 properties
Card
object
9 properties 1 required
NanoId
object
2 properties
Address
object
Object containing details about the address.
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-payout-instruments-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