Make a single payout to an account using our Account Payouts endpoint.
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-01We 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.com/https://access.worldpay.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
Overview
License
Languages
Servers
Try
https://try.access.worldpay.com/
Live
https://access.worldpay.com/
- Try
https://try.access.worldpay.com/accountPayouts/{payoutRequestId}
- Live
https://access.worldpay.com/accountPayouts/{payoutRequestId}
- Payload
- curl
- Python
- Java
- Node.js
- Go
- PHP
- Ruby
- C#
No request payloadOK
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.
ISO 4217 alpha-3 currency code for the remitter account.
Target ISO 4217 alpha-3 currency codes for the payout.
State of the payment.
| Enum Value | Description |
|---|---|
| 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. |
| COMPLETED | Our banking partner has accepted the payout request for processing. Final state or |
| 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). |
| FAILED | Final state in the asynchronous payout request. Please contact your Relationship Manager if this persists, as this might suggest integration issues. |
| INVALID | Final state in the asynchronous payout request. Please contact your Relationship Manager if this persists, as this might suggest integration issues. |
Unique payout request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters.
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" }