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 Balance accounts API

Create and maintain balance accounts.

Worldpay Balance 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 Balance accounts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 4 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 4 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 Balance accounts 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.

Balance accounts 3

Create and maintain balance accounts.

POST
/parties/{partyId}/balanceAccounts
Create a balance account
createBalanceAccount 2 params body → 201400500503
GET
/parties/{partyId}/balanceAccounts/{balanceAccountId}
View a balance account
getBalanceAccount 3 params → 200400500503
PUT
/parties/{partyId}/balanceAccounts/{balanceAccountId}
Update a balance account
updateBalanceAccount 3 params body → 200400500503

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UpdateBalanceAccountRequest (11 properties), BalanceAccount (11 properties), ErrorResponse (6 properties), ErrorResponseItem (6 properties). Each schema is shown below with its type and property counts.

ErrorResponseItem
object
6 properties
ErrorResponse
object
6 properties
BalanceAccount
object
11 properties 1 required
UpdateBalanceAccountRequest
object
Request payload for updating a balance account.
11 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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