Access Worldpay
/
Get Payouts by Unique Payout Request ID (ubr)
/
Retrieve payment details using a ubr

Account Payouts (v2)

Authentication Header

  Authorization: {your_credentials}

Replace {your_credentials} with your base64-encoded Basic Auth username and password given to you by your Implementation Manager.

You must use the Authorization header for any request you send to our Token API, unless you are using client certificate authenticating with SSL/TLS.

Accept Header

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

We use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our Account APIs.

DNS Whitelisting

Whitelist the following URLs:

  • https://try.access.worldpay.com/
  • https://access.worldpay.com/

Please ensure you use DNS whitelisting, not explicit IP whitelisting. When you make a request within Access Worldpay, you should always cache the response returned.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License WorldPay
Languages
Servers
testing(try)
https://try.access.worldpay.com/
live
https://access.worldpay.com/

Single Payout

Operations

Batch Payout

Operations

Get Payouts by Unique Payout Request ID (ubr)

Operations

Retrieve payment details using a ubr

Request

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
Headers
WP-CorrelationIdstring
Example: 15cd16b2-7b82-41cb-9b11-21be9dacad88
WP-CallerIdstring

An ID used for logging purposes.

WP-Timestampstring
Default 1734081651
No request payload

Responses

OK

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
sourceAmountnumber(double)

Source amount. 18 digit precision including 2 decimal places.

targetCurrencystring or null[ 3 .. 3 ]
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.

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. (IBAN is currently not supported).

swiftBicstring or null<= 50

Beneficiary bank account SWIFT/BIC.

entitystring[ 6 .. 6 ]required

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

countryCodestring or null[ 2 .. 2 ]
payoutInstrumentIdstring or null
payoutInstrumentReferencestring or null
Response
application/json
{
  "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",
  "ubr": "PO000N65",
  "narrative": "XYZ102025",
  "transactionReference": "XYZ102025",
  "beneficiaryAccountNumber": "45533882",
  "swiftBic": "BUKBGB22",
  "entity": "000055",
  "countryCode": "AR"
}

Get Payouts

Operations