Retrieve payment details using a ubr

Request

Security

BasicAuth

Path

ubrstringrequired

Unique payout request ID associated with the original payout. We have returned this in the payout response. PN/PZ/PO prefix plus 6 characters.

Example:PZ000N65

WP-CorrelationIdstring, (uuid)

Example:15cd16b2-7b82-41cb-9b11-21be9dacad88

WP-CallerIdstring

An ID used for logging purposes.

WP-Timestampstring

Example: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-bsh.securedataplatform.com/payouts/events/PZ000N65 \
  -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

Bodyapplication/json

paymentIdstring or null

Unique identifier associated with the payment. GUID.

paymentDatetimestring or null, (date-time)

Date and time of the payment submission. DateTime ISO 8601.

payeeNamestring or null, <= 140

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.

sourceCurrencystring or null, <= 3

ISO 4217 alpha-3 currency code for the remitter account.

sourceAmountnumber, (double)

Source amount. 18 digit precision including 2 decimal places.

targetCurrencystring or null, [ 3 .. 3 ]

Target ISO 4217 alpha-3 currency codes for the payout (if different to sourceCurrency, Foreign Exchange (FX) is applied).

targetAmountnumber, (double)

Target amount.

paymentStatestring or null

State of the payment. See appendix for possible states.

bankNamestring or null

Name of the payee (beneficiary) bank which the payout is being made to.

bankCodestring or null

Beneficiary bank account bank code.

ibanstring or null

Beneficiary IBAN. You must either provide the beneficiary's IBAN or account number.

channelstring or null

List of the channels that were sent in the request for this payout

routedChannelstring

The channel that was used to process this payout

bankReferencestring or null

A bank-generated reference that enables customers to track their payout within the payment network. This feature is only available for specific routes. For details on availability, please contact your Relationship Manager.

ubrstring, [ 8 .. 10 ]AlphaNumericRegex = ^[0-9a-zA-Z]+$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.

narrativestring or null, [ 0 .. 50 ]

Reference provided by the remitter of the payment (unique for a remitter). In Account Payouts API - merchantNarrative.

transactionReferencestring or null, [ 0 .. 50 ]

Unique reference provided by you.

beneficiaryAccountNumberstring or null, [ 0 .. 50 ]

Beneficiary bank account number. You must either provide beneficiary's account number or IBAN. Special characters are allowed.

swiftBicstring or null, <= 50

Beneficiary bank account SWIFT/BIC.

entitystring, [ 6 .. 6 ]required

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

countryCodestring or null, [ 2 .. 2 ]

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

payoutInstrumentIdstring or 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.

payoutInstrumentReferencestring or 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.

Response

{
  "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,dom wire",
  "routedChannel": "ach sd",
  "ubr": "PO000N65",
  "bankReference": null,
  "narrative": "XYZ102025",
  "transactionReference": "XYZ102025",
  "beneficiaryAccountNumber": "45533882",
  "swiftBic": "BUKBGB22",
  "entity": "000055",
  "countryCode": "AR"
}