# Retrieve payment details based on the provided information

Endpoint: GET /payouts/events
Version: 2
Security: BasicAuth

## Query parameters:

  - `narrative` (string)
    Reference provided by you.

  - `transactionReference` (string)
    Unique reference provided by you.

  - `accountNumber` (string)
    Beneficiary bank account number. (IBAN is currently not supported).

  - `payoutInstrumentId` (string)
    An ID generated by us, holding the beneficiary bank details.

  - `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)
    6-digit reference given to you by your Implementation Manager during the onboarding process.

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

  - `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)
    Example: "15cd16b2-7b82-41cb-9b11-21be9dacad88"

  - `WP-CallerId` (string)
    An ID used for logging purposes.

  - `WP-Timestamp` (string)

  - `Accept` (string)
    Example: "application/vnd.worldpay.wts.payout-v2+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 payment. See appendix for possible states.

  - `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. You must either provide the beneficiary's IBAN or account number.

  - `items.channel` (string,null)
    List of the channels that were sent in the request for this payout

  - `items.routedChannel` (string)
    The channel that was used to process this payout

  - `items.ubr` (string, required)
    Unique payout request ID associated with a payout submitted through our Account Payouts API. PN/PZ/PO prefix plus 6 characters, e.g. PZ000N65. Five numbers, a letter and finally two/four further numbers.

  - `items.narrative` (string,null)
    Reference provided by the remitter of the payment (unique for a remitter). In Account Payouts API - merchantNarrative.

  - `items.transactionReference` (string,null)
    Unique reference provided by you.

  - `items.beneficiaryAccountNumber` (string,null)
    Beneficiary bank account number. You must either provide beneficiary's account number or IBAN. Special characters are allowed.

  - `items.swiftBic` (string,null)
    Beneficiary bank account SWIFT/BIC.

  - `items.entity` (string, required)
    6-digit reference given to you by your Implementation Manager during the onboarding process.

  - `items.countryCode` (string,null)
    ISO 3166-1 Alpha-2 country code of the payout destination.

  - `items.payoutInstrumentId` (string,null)
    An ID generated by us, holding the beneficiary bank details.You have received this in the response of your "payout instrument creation" call using the Parties API.

  - `items.payoutInstrumentReference` (string,null)
    A reference of the payoutInstrument created by you. This field holds the beneficiary bank details. When not sending the payoutInstrumentReference you can use the payoutInstrumentId instead. When sending both, ensure they relate to the same payoutInstrument.

  - `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):

  - `httpStatusCode` (integer)
    The HTTP Status Code of the response.

  - `customCode` (string)
    Code that is mapped representing a specific scenario.Custom Codes.

  - `message` (string)
    A descriptive message providing more details about the response.

  - `errors` (object)
    Dictionary of errors, containing property name and error description.

## Response 401 fields (application/json):

  - `httpStatusCode` (integer)
    The HTTP Status Code of the response.

  - `customCode` (string)
    Code that is mapped representing a specific scenario.Custom Codes.

  - `message` (string)
    A descriptive message providing more details about the response.

  - `errors` (object)
    Dictionary of errors, containing property name and error description.

## Response 403 fields (application/json):

  - `httpStatusCode` (integer)
    The HTTP Status Code of the response.

  - `customCode` (string)
    Code that is mapped representing a specific scenario.Custom Codes.

  - `message` (string)
    A descriptive message providing more details about the response.

  - `errors` (object)
    Dictionary of errors, containing property name and error description.

## Response 404 fields (application/json):

  - `httpStatusCode` (integer)
    The HTTP Status Code of the response.

  - `customCode` (string)
    Code that is mapped representing a specific scenario.Custom Codes.

  - `message` (string)
    A descriptive message providing more details about the response.

  - `errors` (object)
    Dictionary of errors, containing property name and error description.

## Response 500 fields (application/json):

  - `httpStatusCode` (integer)
    The HTTP Status Code of the response.

  - `customCode` (string)
    Code that is mapped representing a specific scenario.Custom Codes.

  - `message` (string)
    A descriptive message providing more details about the response.

  - `errors` (object)
    Dictionary of errors, containing property name and error description.