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 identifier used to trace and correlate a request across systems. Must be a GUID.
A unique key to identify the request. This is used to prevent duplicate processing of the same request.
ISO 3166-1 Alpha-2 country code of the payout destination.
JSON object of key-value pairs used to supply additional data. The keys and values that you might need to process an account payout to a specific destination, are communicated during the on-boarding process. Duplicate key names are not allowed.
This field is currently not used.
Preferable channel for the payment. Multiple values can be added with a comma-separator, to indicate order of preference.
ID of the FX quote for the request. This must be a valid, active quote which is for the same source and target currencies as the payout request. It must have valid intent
of "FORWARD FX" or "PAYOUT".
Scheduled date of the payout request. Must be a Gregorian calendar date with ISO format 8601 YYYY-MM-DD. This field is currently not used.
Type of transaction. This is mandatory for some payout routes - please check country specific requirements.
Unique reference for the payout request provided by you.
https://try.access.worldpay.com/accountPayouts
https://access.worldpay.com/accountPayouts
{ "merchant": { "entity": "default" }, "instruction": { "value": { "sourceCurrency": "EUR", "sourceAmount": 0, "targetCurrency": "EUR", "targetAmount": 199.99 }, "narrative": { "line1": "PushtoAccount with Worldpay" }, "countryCode": "GB", "fastPayment": false, "beneficiaryBankDetails": { "iban": "GB41CITI18500818404062", "bankName": "Citibank London" }, "parties": [ { "partyType": "beneficiary", "personalDetails": { "type": "Company", "companyName": "Worldpay AP Ltd" }, "address": { "address1": "25 Walbrook", "city": "London", "postalCode": "EC4N 8AF", "countryCode": "GB" } } ] }, "transactionReference": "ABC123456" }
{ "payoutRequestId": "PZ000EC4", "idempotencyKey": "idopKey", "entity": "default" }