# Retrieve payout details Endpoint: GET /accountPayouts/events Version: 2025-01-01 Security: BasicAuth ## Query parameters: - `narrative` (string) Reference that may appear on beneficiary statements. - `transactionReference` (string) Unique reference provided by you. - `accountNumber` (string) Beneficiary bank account number. - `payoutInstrumentId` (string) 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. - `payoutInstrumentReference` (string) A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. - `pageSize` (integer, required) Positive whole number indicating the number of payouts to return in each page. - `entity` (string) Your entity reference created as part of on-boarding. Used to route the request in Access Worldpay. - `countryCode` (string) ISO 3166-1 Alpha-2 country code of the payout destination. - `pageNumber` (integer, required) Positive whole number indicating which page of the statement to return. - `paymentState` (string) Enum: "AWAITING_EXECUTION", "NEW", "VALID", "REJECTED", "EXECUTED", "IN_REVIEW", "RFI_IN_PROGRESS", "AWAITING_LIQUIDITY", "COMPLETED", "REVERSED", "FAILED", "INVALID" - `startDate` (string) 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. - `endDate` (string) 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). - `payeeName` (string) 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 - `sourceCurrency` (string) Source ISO 4217 alpha-3 currency codes for the payout. - `sourceAmount` (number) Source amount. 18 digit precision including 2 decimal places - `targetCurrency` (string) Target ISO 4217 alpha-3 currency codes for the payout. - `targetAmount` (number) 18 digit precision including 2 decimal places ## Header parameters: - `WP-CorrelationId` (string) A unique identifier used to trace and correlate a request across systems. Must be a GUID. Example: "15cd16b2-7b82-41cb-9b11-21be9dacad88" - `WP-Timestamp` (string) - `WP-Api-Version` (string) The version of the API you are using. Example: "2025-01-01" - `Idempotency-Key` (string) A unique key to identify the request. This is used to prevent duplicate processing of the same request. Example: "1234567890" - `Accept` (string) Example: "application/json" ## Response 200 fields (application/json): - `items` (array,null) - `items.paymentId` (string,null) Unique identifier associated with the payment. GUID. - `items.paymentDatetime` (string,null) Date and time of the payment submission. DateTime ISO 8601. - `items.payeeName` (string,null) 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. - `items.sourceCurrency` (string,null) ISO 4217 alpha-3 currency code for the remitter account. - `items.sourceAmount` (number) Source amount. 18 digit precision including 2 decimal places. - `items.targetCurrency` (string,null) Target ISO 4217 alpha-3 currency codes for the payout. - `items.targetAmount` (number) Target amount. - `items.paymentState` (string,null) State of the payout. Enum: "AWAITING_EXECUTION", "NEW", "VALID", "REJECTED", "EXECUTED", "IN_REVIEW", "RFI_IN_PROGRESS", "AWAITING_LIQUIDITY", "COMPLETED", "REVERSED", "FAILED", "INVALID" - `items.bankName` (string,null) Name of the payee (beneficiary) bank which the payout is being made to. - `items.bankCode` (string,null) Beneficiary bank account bank code. - `items.iban` (string,null) Beneficiary IBAN. - `items.estimatedDeliveryDate` (string,null) - `items.outcomeReason` (string,null) - `items.channel` (string,null) List of the channels that were sent in the request for this payout. - `items.routedChannel` (string,null) The channel that was used to process this payout. - `items.payoutRequestId` (string, required) Unique payout request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters. - `items.narrative` (string,null) Reference that may appear on beneficiary statements. - `items.transactionReference` (string,null) Unique reference provided by you. - `items.accountNumber` (string,null) Bank Account number. - `items.swiftBic` (string,null) Beneficiary bank account SWIFT/BIC. - `items.countryCode` (string,null) ISO 3166-1 Alpha-2 country code of the payout destination. - `pagination` (object) - `pagination.pageNumber` (integer, required) Positive whole number indicating which page of the statement to return. Greater than 0. - `pagination.pageSize` (integer, required) Number of items listed per page. - `pagination.pageCount` (integer) Total number of pages. - `pagination.totalNumberOfRecords` (integer) Total number of items listed across all pages. ## Response 400 fields (application/json): - `errorName` (string,null) - `message` (string,null) - `validationErrors` (array,null) - `validationErrors.jsonPath` (string,null) ## Response 401 fields (application/json): - `errorName` (string,null) - `message` (string,null) - `validationErrors` (array,null) - `validationErrors.jsonPath` (string,null) ## Response 403 fields (application/json): - `errorName` (string,null) - `message` (string,null) - `validationErrors` (array,null) - `validationErrors.jsonPath` (string,null) ## Response 500 fields (application/json): - `errorName` (string,null) - `message` (string,null) - `validationErrors` (array,null) - `validationErrors.jsonPath` (string,null)