Skip to content
APIs/Account Payouts/
Get payouts by Payout Req...

Account Payouts (2025-01-01)

Send funds to your customer's bank accounts and search for payouts using parameters.

Authentication header

  Authorization: {your_credentials}

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.

You must use the Authorization header for any request you send to our Account Payouts API

WP-Api-Version header

  WP-Api-Version: 2025-01-01

We use the WP-Api-Version header to identify which version of our API you are using.

DNS whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay-bsh.securedataplatform.com/
  • https://access.worldpay-bsh.securedataplatform.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Test (Try)
https://try.access.worldpay-bsh.securedataplatform.com/
Live
https://access.worldpay-bsh.securedataplatform.com/

Single payout

Make a single payout to an account using our Account Payouts endpoint.

Operations

Batch payout

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

Operations

Get payouts by Payout Request ID

Search for payout details by using a Payout Request ID.

Operations

Retrieve payout details

Request

Security
BasicAuth
Path
payoutRequestIdstringrequired

Unique payout request ID associated with the original payout. We have returned this in the payout response. PN/PZ/PO prefix plus 6 characters.

Example: PZ000N65
Headers
WP-CorrelationIdstring

A unique identifier used to trace and correlate a request across systems. Must be a GUID.

Example: 15cd16b2-7b82-41cb-9b11-21be9dacad88
WP-Timestampstring
Default 1755009817
WP-Api-Versionstring

The version of the API you are using.

Default 2025-01-01
Example: 2025-01-01
Idempotency-Keystring[ 1 .. 35 ]

A unique key to identify the request. This is used to prevent duplicate processing of the same request.

Default 1234567890
Example: 1234567890
Acceptstring
Default application/json
Example: application/json
No request payload

Responses

OK

Bodyapplication/json
paymentIdstring or null

Unique identifier associated with the payment. GUID.

paymentDatetimestring or null(date-time)

Date and time of the payment submission. DateTime ISO 8601.

payeeNamestring or null<= 140

Complete payee name for the payout. This will be one of (depending on the beneficiary type): fullName- concatenated value from title + firstName + middleName + lastName companyName.

sourceCurrencystring or null<= 3

ISO 4217 alpha-3 currency code for the remitter account.

sourceAmountnumber(double)

Source amount. 18 digit precision including 2 decimal places.

targetCurrencystring or null[ 3 .. 3 ]

Target ISO 4217 alpha-3 currency codes for the payout.

targetAmountnumber(double)

Target amount.

paymentStatestring or null

State of the payout.

Enum ValueDescription
AWAITING_EXECUTION

Interim state in the asynchronous payout request. Please contact your Relationship Manager if this persists, as this might suggest integration issues.

NEW

Interim state in the asynchronous payout request. Please contact your Relationship Manager if this persists, as this might suggest integration issues.

VALID

Interim state in the asynchronous payout request. Please contact your Relationship Manager if this persists, as this might suggest integration issues.

REJECTED

Interim state in the asynchronous payout request. Please contact your Relationship Manager if this persists, as this might suggest integration issues.

EXECUTED

The API has accepted your payout request and it is now waiting in the queue for submission to our banking partner.

IN_REVIEW

Payout is currently under review as part of our standard compliance procedures. No action is required from you at this time. We will notify you separately once the review is complete or if we require any further information from you.

RFI_IN_PROGRESS

Payout is currently on hold pending the completion of our standard compliance review. We require additional information from you and will be in touch with the specific details needed. Please respond at your earliest convenience to help us resolve this as quickly as possible.

Note
Please contact your Implementation Manager if you want to receive this.

AWAITING_LIQUIDITY

Payout is currently on hold due to insufficient funds. Please deposit funds into your Worldpay account in order to release the payout and ensure future payouts aren't also held in this state.

Note
Please contact your Implementation Manager if you want to receive this.

COMPLETED

Our banking partner has accepted the payout request for processing. Final state or REVERSED in a return scenario.

REVERSED

Our validation rules, banking partner or beneficiary bank has rejected the payout request. The funds have subsequently been returned to your account. All rejected payouts include a description with reasoning (if available).

bankNamestring or null

Name of the payee (beneficiary) bank which the payout is being made to.

bankCodestring or null

Beneficiary bank account bank code.

ibanstring or null

Beneficiary IBAN.

estimatedDeliveryDatestring or null
outcomeReasonstring or null
channelstring or null

List of the channels that were sent in the request for this payout.

routedChannelstring or null

The channel that was used to process this payout.

payoutRequestIdstring[ 8 .. 10 ]AlphaNumericRegex = ^[0-9a-zA-Z]+$required

Unique payout request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters.

narrativestring or null[ 0 .. 50 ]

Reference that may appear on beneficiary statements.

transactionReferencestring or null[ 0 .. 50 ]

Unique reference provided by you.

accountNumberstring or null[ 0 .. 50 ]

Bank Account number.

swiftBicstring or null<= 50

Beneficiary bank account SWIFT/BIC.

countryCodestring or null[ 2 .. 2 ]

ISO 3166-1 Alpha-2 country code of the payout destination.

Response
application/json
{
  "paymentId": "51a448e5-4430-ee11-b58a-005056b48b8e",
  "paymentDatetime": "2023-08-01T08:24:44.443Z",
  "payeeName": "John Smith",
  "sourceCurrency": "ARS",
  "sourceAmount": 0,
  "targetCurrency": "ARS",
  "targetAmount": 1.05,
  "paymentState": "EXECUTED",
  "bankName": "Test Bank",
  "bankCode": "10 02 04",
  "iban": "GB29NWBK60161331926819",
  "channel": "WIRE,ACH SD",
  "routedChannel": "WIRE",
  "payoutRequestId": "PO000N65",
  "narrative": "XYZ102025",
  "transactionReference": "XYZ102025",
  "accountNumber": "45533882",
  "swiftBic": "BUKBGB22",
  "entity": "default",
  "countryCode": "AR"
}

Get payouts

Search for payout details by filtering parameters.

Operations