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, unless you are using client certificate authentication with SSL/TLS.
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.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.
https://try.access.worldpay.com/
https://access.worldpay.com/
A unique ID generated by us, holding the beneficiary bank details. You receive this in the response after successfully creating a payout instrument in our Parties API.
A reference of the payoutInstrument created by you. This field holds the beneficiary bank details.
Positive whole number indicating the number of payouts to return in each page.
Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.
ISO 3166-1 Alpha-2 country code of the payout destination.
Positive whole number indicating which page of the statement to return.
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. |
Posting start date for the payout. This is the start of a window of time which must satisfy the constraints described. This should be before the current date and before the end date, as well as being after the minimum date (0001-01-01). The difference between start and end dates should not exceed 30 days. Must be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD.
Posting end date for the payout. This is the end of a window of time which must satisfy the constraints described. This should be before the current date, as well as after the start date and the minimum date (0001-01-01).
Complete payee name for the payout. This will be one of the following (depending on the beneficiary type): fullName - concatenated value from title + firstName + middleName + lastName; companyName
Source ISO 4217 alpha-3 currency codes for the payout.
Target ISO 4217 alpha-3 currency codes for the payout.
https://try.access.worldpay.com/accountPayouts/events
https://access.worldpay.com/accountPayouts/events
No request payload
OK
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.
Positive whole number indicating which page of the statement to return. Greater than 0.
{ "items": [ { "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", "payoutRequestId": "PO000N65", "narrative": "XYZ102025", "transactionReference": "XYZ102025", "accountNumber": "45533882", "swiftBic": "BUKBGB22", "entity": "default", "countryCode": "AR" }, { "paymentId": "c1b659f6-4c30-ee11-b58a-005056b48b8e", "paymentDatetime": "2023-08-01T09:22:41.377Z", "payeeName": "John Johno Johnson", "sourceCurrency": "GBP", "sourceAmount": 0, "targetCurrency": "GBP", "targetAmount": 10, "paymentState": "EXECUTED", "bankName": "Test Bank", "bankCode": "404433", "iban": "GB29NWBK60161331926819", "payoutRequestId": "PN00004N", "narrative": "Ref: 123456", "transactionReference": "123456", "accountNumber": "12345677", "swiftBic": "BUKBGB22", "entity": "default", "countryCode": "GB" } ], "pagination": { "pageNumber": 1, "pageSize": 2, "pageCount": 5610, "totalNumberOfRecords": 11220 } }