APIs
/
Account Payouts
/
Single payout

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, 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. You must use the Accept header for any request you send to our Account Payouts API.

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
openapi.json
openapi.yaml
Overview
License Worldpay
Languages
Servers
Try
https://try.access.worldpay.com/
Live
https://access.worldpay.com/

Single payout

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

Operations

Make a single payout

Request

Headers
WP-CorrelationIdstring

A unique key to identify the request. Must be a GUID.

Example: 15cd16b2-7b82-41cb-9b11-21be9dacad88
WP-Timestampstring
Default 1745593477
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 requests.

Default 1234567890
Example: 1234567890
Bodyapplication/json
merchantobject
entitystring[ 1 .. 32 ]required

Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.

Example: "default"
instructionobject
countryCodestring[ 2 .. 2 ]required
expandableKeyValuePairsobject or null

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.

channelstring or null

Preferable channel for the payment. Multiple values can be added with a comma-separator, to indicate order of preference.

Enum"ACH""NDACH""WIRE""INSTANT""SEPA""LOCAL""INTERNAL""RTP"
quoteIdstring or null

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".

scheduleDatestring or null[ 10 .. 10 ]

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.

sourceobject
beneficiaryBankDetailsobject
valueobject
partiesArray of objects
narrativeobject
purposeOfPaymentobject
transactionTypestring or null
Enum"customerToCustomer""businessToBusiness""government""reversal""return""customerToBusiness""businessToCustomer"
fastPaymentboolean

Flag for a fast payment. If supplied the value for the field must be Y.

transactionReferencestring[ 6 .. 50 ]required

Unique reference for the payout request provided by you.

notificationUrlstring or null<= 250

Currently not in use.

application/json
{
  "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"
}

Responses

OK response if a request with the same credentials has already been submitted successfully

Bodyapplication/json
payoutRequestIdstring

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

idempotencyKeyany

Unique reference from the request header of the same name.

entitystring

Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay.

Response
application/json
{
  "payoutRequestId": "PZ000EC4",
  "idempotencyKey": "idopKey",
  "entity": "default"
}

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

Get payouts

Search for payout details by filtering parameters.

Operations