Payment Item Search

Search through payouts submitted either as single payout or as part of a batch. Refine your search by UBR (unique bankout reference), payment item id or using a query string with filters.

Payment Item Search request

Accept: application/vnd.worldpay.account-payouts-v2+json

Payment Item Search uses GET requests with parameters defined in the path (URL) supplied.

Below sample Payment Item Search query strings are shown, refining using filters, by UBR or by Payment Id.

GET https://try.access.worldpay.com/payouts/events?entity=000000&startDate=2022-01-01&endDate=2022-02-01&payeeName=John+Doe&merchantReference=aaa&paymentReference=aaa&accountNumber=0000&sourceCurrency=EUR&sourceAmount=5.15&targetCurrency=USD&targetAmount=5.55&countryCode=UK&pageNumber=1&pageSize=1

GET https://try.access.worldpay.com/payouts/events/PO20000N88

GET https://try.access.worldpay.com/payouts/events/id/27ae566e-6530-ee11-b58a-005056b48b8e

Parameters

Permitted special characters for appropriate fields, as well as preset values for specific fields are listed in the Appendix.

Response structure

|items|targetCurrency|Currency for the payee's account.|String (3 characters maximum)| |items|targetAmount|Amount being received by the payee. Either this or the sourceAmount may be supplied for the transaction. If the transaction is cross-currency this value could differ due to conversion depending on the applicable foreign exchange. If targetAmount is specified, FX will be applied to determine the amount that will be deducted from the customer account.|Decimal, 18 digit precision including 2 decimal places|

|items|countryCode|Country that the payout is being made in.|String (2 characters maximum)| |items|paymentState|State of the payment.|For the full list of values please see here| |items|bankName|Name of the payee (beneficiary) bank which the payout is being made to.|String (50 characters maximum)| |items|bankCode|Beneficiary bank account bank code.|String (50 characters maximum)| |items|iban|Beneficiary IBAN.|String (50 characters maximum)| |pagination|pageNumber|Page that the transaction is listed on.|Integer| |pagination|pageSize|Number of items listed per page.|Integer| |pagination|pageCount|Total number of pages.|Integer| |pagination|totalNumberOfRecords|Total number of items listed across all pages.|Integer|

Example Payment Item Search response body:

{
    "items": [
        {
            "ubr": "PO000N65",
            "narrative": "XYZ102025",
            "transactionReference": "XYZ102025",
            "beneficiaryAccountNumber": "45533882",
            "swiftBic": "BUKBGB22",
            "entity": "000055",
            "countryCode": "AR",
            "paymentId": "51a448e5-4430-ee11-b58a-005056b48b8e",
            "paymentDatetime": "2023-08-01T08:24:44.443",
            "payeeName": "John Smith",
            "sourceCurrency": "ARS",
            "sourceAmount": 0.00,
            "targetCurrency": "ARS",
            "targetAmount": 1.05,
            "paymentState": "EXECUTED",
            "bankName": "Test Bank",
            "bankCode": "10 02 04",
            "iban": "GB29NWBK60161331926819"
        },
        {
            "ubr": "PN00004N",
            "narrative": "Ref: 123456",
            "transactionReference": "123456",
            "beneficiaryAccountNumber": "12345677",
            "swiftBic": "BUKBGB22",
            "entity": "000055",
            "countryCode": "GB",
            "paymentId": "c1b659f6-4c30-ee11-b58a-005056b48b8e",
            "paymentDatetime": "2023-08-01T09:22:41.377",
            "payeeName": "John Johno Johnson",
            "sourceCurrency": "GBP",
            "sourceAmount": 0.00,
            "targetCurrency": "GBP",
            "targetAmount": 10.00,
            "paymentState": "EXECUTED",
            "bankName": "Test Bank",
            "bankCode": "404433",
            "iban": "GB29NWBK60161331926819"
        }
    ],
    "pagination": {
        "pageNumber": 1,
        "pageSize": 2,
        "pageCount": 5610,
        "totalNumberOfRecords": 11220
    }
}

Error response example

{
    "errors": {
        "callerId": [
            "CallerId is mandatory"
        ]
    },
    "httpStatusCode": 400,
    "customCode": "SPAB01",
    "message": "There was an error in the request"
}

Error response codes

General

Schema Validation Responses