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 Payouts API

The Payouts API from Worldpay — 4 operation(s) for payouts.

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

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

This API exposes 4 operations across 4 paths, and defines 20 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.

4 operations 4 paths 20 schemas 2 GET2 POST

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 Payouts API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Payouts 4
GET
/payouts/{resource}
Retrieve payout details
getPayoutsDetails 1 param → 200401404
GET
/payouts/query
Retrieve payout details from a historic resource
queryPayouts 2 params → 200400401404422
POST
/payouts/basicDisbursement
Standard payout
basicDisbursement body → 201400422500
POST
/payouts/fastAccess
Fast Access payout
fastAccess body → 201400422500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are card_plain (5 properties), applepay_decrypted (5 properties), payouts_fastAccess_201_response (4 properties), payouts_payouts_200_response (3 properties). Each schema is shown below with its type and property counts.

payouts_basicDisbursement_500_response
object
2 properties
payouts_basicDisbursement_201_response
object
3 properties 3 required
payouts_query_200_response
object
3 properties 3 required
card_networkToken
object
Network Payment Token details.
3 properties 3 required
payouts_basicDisbursement_400_response
object
3 properties
payouts_payouts_404_response
object
2 properties
payouts_fastAccess_500_response
object
2 properties
payouts_fastAccess_201_response
object
4 properties 3 required
card_tokenized
object
Tokenized card details.
2 properties 2 required
applepay_decrypted
object
Wallet details.
5 properties 3 required
payouts_basicDisbursement_422_response
object
3 properties
payouts_payouts_401_response
object
2 properties
payouts_payouts_400_response
object
3 properties
scheme
object
2 properties 1 required
card_plain
object
Plain card details.
5 properties 3 required
payouts_payouts_200_response
object
3 properties 3 required
payouts_basicDisbursement
object
Basic disbursement input.
3 properties 3 required
payouts_fastAccess
object
Fast access input.
3 properties 3 required
payouts_fastAccess_400_response
object
3 properties
payouts_fastAccess_422_response
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldpay-payouts-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