Retrieve payout details

APIs/Account Payouts/Get payouts/

Request

Security

BasicAuth

Query

walletIdentifierstring, [ 0 .. 64 ]

Beneficiary crypto wallet ID.

narrativestring, [ 0 .. 50 ]

Reference that may appear on beneficiary statements.

transactionReferencestring, [ 0 .. 50 ]

Unique reference provided by you.

accountNumberstring, [ 0 .. 64 ]

Beneficiary bank account number.

payoutInstrumentIdstring

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.

payoutInstrumentReferencestring

A reference of the payoutInstrument created by you. This field holds the beneficiary bank details.

pageSizeinteger, (int32), [ 1 .. 499 ]required

Positive whole number indicating the number of payouts to return in each page.

entitystring, [ 6 .. 6 ]

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

countryCodestring, [ 2 .. 2 ]

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

pageNumberinteger, (int32), >= 1required

Positive whole number indicating which page of the statement to return.

paymentStatestring, <= 255

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

startDatestring, [ 10 .. 10 ]

Posting start date for the payout. This is the start of a time window. This must 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 31 days. Must be a Gregorian calendar date with ISO 8601 format YYYY-MM-DD.

endDatestring, [ 10 .. 10 ]

Posting end date for the payout. This is the end of a time window. This must be before the current date, as well as after the start date and the minimum date (0001-01-01).

payeeNamestring, [ 0 .. 140 ]

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

sourceCurrencystring, [ 3 .. 3 ]

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

sourceAmountnumber, (double), [ 1 .. 19 ]

Source amount. 18 digit precision including 2 decimal places

targetCurrencystring, [ 1 .. 35 ]

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

targetAmountnumber, (double), [ 1 .. 35 ]

18 digit precision including 2 decimal places

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:"1755681620"

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:"mustBeUnique12345"

Example:mustBeUnique12345

Acceptstring

Default:"application/json"

Example:application/json

curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/accountPayouts/events?walletIdentifier=string&narrative=string&transactionReference=string&accountNumber=string&payoutInstrumentId=string&payoutInstrumentReference=string&pageSize=1&entity=string&countryCode=string&pageNumber=1&paymentState=AWAITING_EXECUTION&startDate=string&endDate=string&payeeName=string&sourceCurrency=string&sourceAmount=1&targetCurrency=string&targetAmount=1' \
  -H 'Accept: application/json' \
  -H 'Idempotency-Key: mustBeUnique12345' \
  -H 'WP-Api-Version: 2025-01-01' \
  -H 'WP-CorrelationId: 15cd16b2-7b82-41cb-9b11-21be9dacad88' \
  -H 'WP-Timestamp: 1755681620'

Responses

Bodyapplication/json

itemsArray of objects or null

paginationobject

Response

{
  "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",
      "channel": "WIRE,ACH SD",
      "routedChannel": "WIRE",
      "bankReference": "ABCHK24",
      "payoutRequestId": "PO000N65",
      "narrative": "XYZ102025",
      "transactionReference": "XYZ102025",
      "accountNumber": "45533882",
      "walletIdentifier": null,
      "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": null,
      "bankCode": null,
      "iban": null,
      "channel": "WIRE,ACH SD,DOM",
      "routedChannel": "ACH SD",
      "bankReference": "ABCHK25",
      "payoutRequestId": "PN00004N",
      "narrative": "Ref: 123456",
      "transactionReference": "123456",
      "accountNumber": null,
      "walletIdentifier": "0x7bD3a4F8c91eE2F4b0c14F72bC8A3b9D8dE12A55",
      "swiftBic": null,
      "entity": "default",
      "countryCode": "GB"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 2,
    "pageCount": 5610,
    "totalNumberOfRecords": 11220
  }
}