Worldpay
Keep Worldpay in step with your orders, invoices and payments without re-keying, with the right person approving what changes.
23 ways to read.
Quality checks
Built and tested with example responses.
- Ready to connect: doneEvery listed action is built in.
- Built and tested with example responses: doneEach action is built from the provider’s published API and tested against example responses, errors, rate limits and paging.
Connected, approved, proven.
The things teams do most with Worldpay, an example flow with a person in the loop, and what Nexra keeps as proof.
Top actions
- Get balance accountRead
Example flow
- Worldpay · Get balance accountDone
- Nexra · Record the decision and result in the evidence chainProven
Example workflow. Routine runs go through on their own. Only a change your rules flag, such as one over a limit you set, waits for the right person, who sees the exact change and the rule before it reaches Worldpay.
What gets logged
- Whether it ran on its own or who approved it, and under which rule
- A fingerprint of the exact request sent to Worldpay
- Worldpay's reply: what it created or changed
- One entry in the evidence chain, linked to the one before
Try this in the sandbox
Run the whole flow with test data in your sandbox, then connect a Worldpay test account before you go live.
For developers
Technical detail
Access Worldpay read-only: payment queries, payment events, masked card tokens, balances, statements with refunds, chargebacks and commission, account payouts, FX rates and parties.
Worldpay API docs- Source actions
- 23
- Data types
- 17
What you can map
Reads are always available. Writes are off until you switch them on for a connection, and governed writes follow your policies.
Archived payments1
- Find historical paymentsSource
Payments processed before 25 June 2024, by transaction reference and entity.
Balance accounts2
- Get balance accountSource
One Worldpay balance account and its balances.
- List balance accountsSource
Worldpay balance accounts for an entity with cleared, uncleared and total balances.
Disputes1
- List chargebacksSourceIncremental
Chargeback entries on a balance account statement (transfer type CHARGEBACK), in a window of up to 31 days.
Fees1
- List commission feesSourceIncremental
Commission entries on a balance account statement (transfer type COMMISSION), in a window of up to 31 days.
Fx markups1
- Get FX markupSource
The markup applied to your FX rates for an entity and optional currency pair.
Fx quotes1
- Get FX quoteSource
An existing FX quote's rate and expiry; never creates quotes or contracts.
Fx rates1
- List FX ratesSource
Current Worldpay FX bid and ask rates by intent and currency pair.
Parties2
- Get partySource
One party with its verification state and linked balance account and payout instrument IDs.
- List partiesSource
Marketplace parties (payees and payers) with type, status and verification state; contact and identity details are omitted.
Party balance accounts1
- Get party balance accountSource
A party's balance account currency and scheduled payout settings.
Party identity verifications1
- Get party identity verificationSource
A party's identity verification state, and each beneficial owner's state.
Party payout instruments1
- Get party payout instrumentSource
A party's payout instrument type, currency and bank routing. Holder name, address, IBAN and account number are never mapped.
Payment details1
- Get payment by IDSource
One payment with its full event history.
Payments3
- Read latest payment eventSource
Follow an existing Worldpay events link on the selected origin; never executes payment actions.
- Query payments by date rangeSourceIncremental
Card payments in a date-time window, with optional currency, amount, entity and event filters (payments after 25 June 2024).
- Find payments by referenceSource
Payments with your transaction reference, or order reference (order references cover payments after 20 August 2026).
Payouts2
- Get payout by request IDSource
The payout(s) created by one payout request.
- Search account payoutsSourceIncremental
Account payouts with their state, amounts and bank routing, filtered by date, reference, state, currency or payout instrument.
Refunds1
- List refundsSourceIncremental
Refund debits on a balance account statement (transfer type REFUND), in a window of up to 31 days. Nexra never issues refunds.
Statement items1
- List account statement itemsSourceIncremental
Credits and debits on a balance account (settlements, chargebacks, commission, refunds, payouts) in a window of up to 31 days.
Tokens2
- Get tokenSource
One token's masked card details and expiry by Worldpay token ID.
- List tokens in a namespaceSource
Card tokens grouped under your namespace (masked details only, up to 16).
Access and limits
- Authentication
- Access Worldpay Basic credentials
- Plans and access
- An Access Worldpay merchant with API credentials enabled for Payment Queries (and Tokens, Balances, Statements, Account Payouts, FX or Parties for those reads). Payment Queries returns card payments processed after 25 June 2024; older payments use the historical query.
- Test environment
- Access Worldpay Try environment (try.access.worldpay.com) with test credentials.
- Rate limits
- Worldpay does not publish fixed limits; HTTP 429 and Retry-After are honoured with bounded retries.
- Pagination
- Payment queries follow _links.next.href up to 300 payments per page; balances, statements, payouts and parties use page numbers with a reported page count; other reads return one page.
- Provider events
- Access Worldpay sends payment event notifications to a configured URL. Flows run on demand, on a schedule, or when a scheduled check finds new or changed records.
Before you build a flow
- Read only. Intentional exclusions: authorizations, sales, settlements, partial settlements, cancellations, reversals, refunds, payouts, account transfers, money transfers, card payouts, split payments, FX quote and contract creation, FX markup changes, and every token create, update, delete, detokenize or network-token call.
- Parties writes (create, update, activation, beneficial owners, payout instruments, identity verification) are excluded: they carry identity documents and bank details and enable payouts.
- Card BIN Data, Card Verifications and 3DS are excluded because they take card numbers.
- No public API for disputes or webhook configuration: chargebacks appear as CHARGEBACK statement items (disputes.list) and Events webhooks are configured by your Worldpay Implementation Manager. Dispute reasons, evidence and deadlines are not available.
- Refunds, chargebacks and commission come from the balance account statement (Statements API), which needs a Worldpay balance account. Card-only merchants without one can see refunds only as refundRequested events on Payment Queries payments.
- Fees: the only fee data in Worldpay's API is COMMISSION statement entries (fees.list); per-transaction processing fees and interchange are not reported. Payout records carry no fee fields.
- Payout lines: Worldpay has no 'transactions in this payout' read. Settlements, refunds, chargebacks and payouts are lines on the balance account statement (statement_items.list), which carries no payout ID.
- Payout account numbers, IBANs, payee names, party emails, phones and identity documents are never mapped; only the last four characters of an account identifier are returned.
- The connection check still follows the configured payments:events link, so that setting stays required.
- Payment Queries covers card payments after 25 June 2024; order-reference lookups cover payments after 20 August 2026.
- Card BIN, payment account reference, holder name and billing address are not mapped; the last-four filter is not exposed.
Developer reference
- Create the Worldpay credentials described above with the narrowest permissions your flows need.
- In Nexra, open Connect, then Connections, then New connection, choose Worldpay, enter its settings and credentials, and tick only the write actions you need. Connection guide
- Test the connection, then use its actions as flow sources and destinations. Flow guide
Machine-readable detail: GET /api/public/connect/connectors/worldpay and the Connections API.