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

The Accounts API from Worldpay — 4 operation(s) for accounts.

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

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

This API exposes 4 operations across 4 paths, and defines 18 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 18 schemas 3 GET1 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 Accounts 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 — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Accounts 4
GET
/accounts/{accountNumber}
Get account details
ReceiveTransferRequestForAccount 4 params → 200400401403500
GET
/accounts
Get details for all your accounts
ReceiveTransferRequest 9 params → 200400401403500
GET
/accounts/statements
Query account statement items
GetStatements 17 params → 200204400401403404500
POST
/accounts/transfer
Transfer funds between your accounts
ReceiveTransferRequest 4 params body → 202400401403404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ExternalAccountStatementItemsV2 (15 properties), Account (7 properties), ExternalStatementResponseV2 (7 properties), TransferRequest (5 properties). Each schema is shown below with its type and property counts.

ValidationErrors_2
object
3 properties
PageInformation
object
4 properties
ExternalStatementResponseV2
object
7 properties
ValidationErrors
object
3 properties
BaseAccessErrorResponse_2
object
3 properties
ExtendedAccessErrorResponse
object
4 properties
AccountByEntityResponse
object
3 properties
AwQueryParameterErrorModel
object
3 properties
ExternalAccountStatementItemsV2
object
15 properties
BaseAccessErrorResponse_3
object
2 properties
ErrorResponse
object
4 properties
TransferRequest
object
5 properties 4 required
BaseAccessErrorResponse
object
3 properties
AccountResponse
object
The Get Account response
2 properties
ExtendedAccessErrorResponse_2
object
3 properties
TransferResponse
object
Account
object
7 properties
ExternalNarrativeV2
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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