Skip to content
APIs/Account Payouts/Get Payouts

Get Payouts

Operations

Retrieve payment details based on the provided information

Request

Security
BasicAuth
Query
narrativestring, [ 0 .. 50 ]

Reference provided by you.

transactionReferencestring, [ 0 .. 50 ]

Unique reference provided by you.

accountNumberstring, [ 0 .. 64 ]

Beneficiary bank account number. (IBAN is currently not supported).

payoutInstrumentIdstring

An ID generated by us, holding the beneficiary bank details.

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 ]

6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process.

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
startDatestring, [ 10 .. 10 ]

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

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.

Headers
WP-CorrelationIdstring
Example:15cd16b2-7b82-41cb-9b11-21be9dacad88
WP-CallerIdstring

An ID used for logging purposes.

WP-Timestampstring
Default:"1743087806"
Acceptstring
Default:"application/vnd.worldpay.wts.payout-v2+json"
Example:application/vnd.worldpay.wts.payout-v2+json
curl -i -X GET \
  -u '<username>:<password>' \
  'https://try.access.worldpay.com/payouts/events?narrative=string&transactionReference=string&accountNumber=string&payoutInstrumentId=string&payoutInstrumentReference=string&pageSize=1&entity=string&countryCode=string&pageNumber=1&paymentState=string&startDate=string&endDate=string&payeeName=string&sourceCurrency=string&sourceAmount=1&targetCurrency=string&targetAmount=1' \
  -H 'Accept: application/vnd.worldpay.wts.payout-v2+json' \
  -H 'WP-CallerId: string' \
  -H 'WP-CorrelationId: 15cd16b2-7b82-41cb-9b11-21be9dacad88' \
  -H 'WP-Timestamp: 1743087806'

Responses

OK

Bodyapplication/json
itemsArray of objects or null
paginationobject
Response
{
  "items": [
    {
      "paymentId": "51a448e5-4430-ee11-b58a-005056b48b8e",
      "paymentDatetime": "2023-08-01T08:24:44.443",
      "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",
      "ubr": "PO000N65",
      "bankReference": "PQRHK49",
      "narrative": "XYZ102025",
      "transactionReference": "XYZ102025",
      "beneficiaryAccountNumber": "45533882",
      "swiftBic": "BUKBGB22",
      "entity": "000055",
      "countryCode": "AR"
    },
    {
      "paymentId": "c1b659f6-4c30-ee11-b58a-005056b48b8e",
      "paymentDatetime": "2023-08-01T09:22:41.377",
      "payeeName": "John Johno Johnson",
      "sourceCurrency": "GBP",
      "sourceAmount": 0,
      "targetCurrency": "GBP",
      "targetAmount": 10,
      "paymentState": "EXECUTED",
      "bankName": "Test Bank",
      "bankCode": "404433",
      "iban": "GB29NWBK60161331926819",
      "channel": "wire,ach sd,dom wire",
      "routedChannel": "ach sd",
      "ubr": "PN00004N",
      "bankReference": "PQRHK50",
      "narrative": "Ref: 123456",
      "transactionReference": "123456",
      "beneficiaryAccountNumber": "12345677",
      "swiftBic": "BUKBGB22",
      "entity": "000055",
      "countryCode": "GB"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "pageSize": 2,
    "pageCount": 5610,
    "totalNumberOfRecords": 11220
  }
}