API Reference Worldpay v#1.0.0

Copy Markdown View Source

Modules

Worldpay — Complete Elixir client for the Worldpay payment platform.

Worldpay APMs API — Alternative Payment Methods.

Worldpay Account Payouts API — push funds to bank accounts.

Internal fund transfers between virtual balance accounts.

Worldpay Account Updater — keep stored card credentials current.

Query virtual account balances.

Worldpay cnpAPI — US eCommerce XML processing (Vantiv platform).

Builds cnpAPI XML request documents for US eCommerce processing.

Parses cnpAPI XML responses.

Worldpay Card BIN API — issuer, scheme, and capability lookup.

Worldpay Card Payments API — modular card authorization.

Builder helpers for advanced Card Payments API features.

Worldpay Card Payouts API — push funds to Visa / Mastercard cards.

Low-level HTTP client for all Worldpay REST APIs.

Runtime configuration for the Worldpay client.

Worldpay Customer Event Service API — lifecycle events for provisioned NPTs.

Structured error returned from all Worldpay API calls.

Worldpay Exemptions API — standalone SCA exemption requests.

Worldpay Express Interface (Integrated Payments Express) — lighter POS integration path covering all in-store payment types.

Worldpay FX API — Multi-Currency Processing.

Worldpay Forward API — PCI-scope-reducing proxy/tokenizer.

Worldpay FraudSight API — ML-based fraud risk assessment and SCA exemptions.

Worldpay Hosted Payment Page (HPP) API — hosted checkout and pay-by-link.

Worldpay Parties API — onboard and manage marketplace sellers.

Worldpay Split Payments API — allocate a payment across balance accounts.

Worldpay Money Transfers API — Original Credit Transactions (OCTs).

Worldpay Network Payment Token (NPT) API — manages network payment tokens that can be used across Worldpay and other acquirers.

Worldpay Merchant Boarding API — onboard merchants programmatically.

Worldpay Lead Submission API — submit merchant leads to Worldpay Salesforce CRM.

Worldpay Transaction Notification API — parse partner transaction notifications.

Worldpay Terminal Lease Notification API — equipment lease alerts.

Worldpay Payment Queries API — query payment history.

Worldpay Payments API — orchestrated single-call flow.

Worldpay RAFT 610 Interface — ISO 8583 card-present processing.

Extractors for RAFT ISO 8583 response fields.

Worldpay Batch Transaction API (Access).

Helpers for cnpAPI batch file processing.

Worldpay Enhanced Merchant Activity File (eMAF) parser.

Billing or shipping address.

Monetary amount with currency.

Stored credential agreement types: :card_on_file | :subscription | :installment | :unscheduled

Account Funding Transaction (AFT) metadata.

Merchant entity reference, including optional PayFac data.

Statement narrative (merchant descriptor on card statement).

Payment instrument variants.

3DS authentication result to attach to a payment.

Worldpay Security Token Service (STS) API — provision, exchange, and detokenize raw card/account numbers.

Retrieve settlement statements (deposit summaries).

Telemetry integration for all Worldpay API calls.

Worldpay 3DS API — Strong Customer Authentication.

Worldpay Token Import — migrate tokens from a previous provider.

Worldpay Tokens API — Worldpay tokens and Network tokens (NPTs).

Worldpay Verifications API — card and bank account verification.

Worldpay WPG (Worldpay Payment Gateway) — XML-based gateway client.

Builds WPG XML request documents.

Advanced WPG features: DCC, Guaranteed Payments, Prime Routing, Revenue Boost, Lodging, MAC, zero-value auth, stored credentials, submission fulfillment, and JSC device data snippet builder.

Parses WPG XML responses into string-keyed maps.

Worldpay webhook event parsing and dispatch.

Behaviour for Worldpay webhook event handlers.