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 Batch payout API

Make up to 500 payouts in one batch using our Account Payouts endpoint.

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

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

This API exposes 1 operation across 1 path, 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.

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

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Batch payout 1

Make up to 500 payouts in one batch using our Account Payouts endpoint.

POST
/accountPayouts/batch
Make a batch payout
PostBatchPayout 5 params body → 200202400401403500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PayoutInstruction (13 properties), WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PersonalDetails (12 properties), WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.BankDetails (10 properties), WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PartyAddress (8 properties). Each schema is shown below with its type and property counts.

WP.FXT.SinglePayoutApi.Domain.PayoutBatch.V2.Models.PayoutBatchUniqueIdAndUbrV3
object
2 properties
WP.FXT.SinglePayoutApi.Domain.PayoutBatch.V2.Models.BatchPayout
object
3 properties 1 required
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Source
object
1 property
WP.FXT.SinglePayoutApi.Domain.PayoutBatch.V2.Models.BatchIdentifier
object
2 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PartyAddress
object
8 properties
WP.FXT.SinglePayoutApi.Domain.PayoutBatch.V2.Models.PayoutBatchRequest
object
3 properties
WP.FXT.SinglePayoutApi.Domain.Shared.ErrorModels.AwJsonPathErrorModel
object
3 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PurposeOfPayment
object
Details about the purpose of the payment. Note: View our [bank coverage guide](/products/marketplaces/coverage/bank) for country specific requirements.
2 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Phone
object
2 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.CurrencyInfo
object
4 properties 1 required
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Narrative
object
1 property
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Party
object
6 properties 1 required
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.BankDetails
object
The bank details of the beneficiary. Note: View our [bank coverage guide](/products/marketplaces/coverage/bank) for country specific requirements.
10 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PersonalDetails
object
Only supply either partyReference or personalDetails.
12 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Identity
object
6 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.BankAddress
object
6 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.PayoutInstruction
object
13 properties 1 required
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.WalletDetails
object
2 properties
WP.FXT.SinglePayoutApi.Domain.Shared.ErrorModels.AwBodyErrorModel
object
3 properties
WP.FXT.SinglePayoutApi.Domain.Payout.V3.Models.Merchant
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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