# Worldpay v1.0.0 - Table of Contents

> Full-featured Elixir client for the Worldpay payment platform — Access APIs, WPG, RAFT, APMs, Marketplaces, Payouts, FraudSight, 3DS, Tokens and more.

## Pages

- [Worldpay](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- [Worldpay.CNP](Worldpay.CNP.md): Worldpay **cnpAPI** — US eCommerce XML processing (Vantiv platform).
- [Worldpay.CNP.Builder](Worldpay.CNP.Builder.md): Builds cnpAPI XML request documents for US eCommerce processing.
- [Worldpay.CNP.Parser](Worldpay.CNP.Parser.md): Parses cnpAPI XML responses.
- [Worldpay.CardPayments.Features](Worldpay.CardPayments.Features.md): Builder helpers for advanced Card Payments API features.
- [Worldpay.CustomerEventService](Worldpay.CustomerEventService.md): Worldpay **Customer Event Service API** — lifecycle events for provisioned NPTs.
- [Worldpay.Express](Worldpay.Express.md): Worldpay **Express Interface** (Integrated Payments Express) — lighter POS
integration path covering all in-store payment types.
- [Worldpay.ForwardAPI](Worldpay.ForwardAPI.md): Worldpay **Forward API** — PCI-scope-reducing proxy/tokenizer.
- [Worldpay.HPP](Worldpay.HPP.md): Worldpay **Hosted Payment Page (HPP)** API — hosted checkout and pay-by-link.
- [Worldpay.NetworkPaymentTokens](Worldpay.NetworkPaymentTokens.md): Worldpay **Network Payment Token (NPT) API** — manages network payment tokens
that can be used across Worldpay and other acquirers.
- [Worldpay.Partner.Boarding](Worldpay.Partner.Boarding.md): Worldpay **Merchant Boarding API** — onboard merchants programmatically.
- [Worldpay.Partner.LeadSubmission](Worldpay.Partner.LeadSubmission.md): Worldpay **Lead Submission API** — submit merchant leads to Worldpay Salesforce CRM.
- [Worldpay.Partner.Notifications](Worldpay.Partner.Notifications.md): Worldpay **Transaction Notification API** — parse partner transaction notifications.
- [Worldpay.Partner.TerminalLease](Worldpay.Partner.TerminalLease.md): Worldpay **Terminal Lease Notification API** — equipment lease alerts.
- [Worldpay.RAFT](Worldpay.RAFT.md): Worldpay **RAFT 610 Interface** — ISO 8583 card-present processing.
- [Worldpay.RAFT.Response](Worldpay.RAFT.Response.md): Extractors for RAFT ISO 8583 response fields.
- [Worldpay.Reporting.BatchTransactions](Worldpay.Reporting.BatchTransactions.md): Worldpay **Batch Transaction API** (Access).
- [Worldpay.Reporting.CNPBatch](Worldpay.Reporting.CNPBatch.md): Helpers for **cnpAPI batch file** processing.
- [Worldpay.Reporting.EMAF](Worldpay.Reporting.EMAF.md): Worldpay **Enhanced Merchant Activity File (eMAF)** parser.
- [Worldpay.SecurityTokenService](Worldpay.SecurityTokenService.md): Worldpay **Security Token Service (STS) API** — provision, exchange,
and detokenize raw card/account numbers.
- [Worldpay.TokenImport](Worldpay.TokenImport.md): Worldpay **Token Import** — migrate tokens from a previous provider.
- [Worldpay.WPG.Features](Worldpay.WPG.Features.md): 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.
- [Worldpay.Webhooks](Worldpay.Webhooks.md): Worldpay webhook event parsing and dispatch.
- [Worldpay.Webhooks.Handler](Worldpay.Webhooks.Handler.md): Behaviour for Worldpay webhook event handlers.

- Core
  - [Worldpay](Worldpay.md): **Worldpay** — Complete Elixir client for the Worldpay payment platform.
  - [Worldpay.Client](Worldpay.Client.md): Low-level HTTP client for all Worldpay REST APIs.
  - [Worldpay.Config](Worldpay.Config.md): Runtime configuration for the Worldpay client.

- Access — Payments
  - [Worldpay.APMs](Worldpay.APMs.md): Worldpay **APMs API** — Alternative Payment Methods.
  - [Worldpay.CardPayments](Worldpay.CardPayments.md): Worldpay **Card Payments API** — modular card authorization.
  - [Worldpay.Payments](Worldpay.Payments.md): Worldpay **Payments API** — orchestrated single-call flow.

- Access — Auth & Risk
  - [Worldpay.Exemptions](Worldpay.Exemptions.md): Worldpay **Exemptions API** — standalone SCA exemption requests.
  - [Worldpay.FraudSight](Worldpay.FraudSight.md): Worldpay **FraudSight API** — ML-based fraud risk assessment and SCA exemptions.
  - [Worldpay.ThreeDS](Worldpay.ThreeDS.md): Worldpay **3DS API** — Strong Customer Authentication.
  - [Worldpay.Verifications](Worldpay.Verifications.md): Worldpay **Verifications API** — card and bank account verification.

- Access — Tokens
  - [Worldpay.Tokens](Worldpay.Tokens.md): Worldpay **Tokens API** — Worldpay tokens and Network tokens (NPTs).

- Access — Payouts
  - [Worldpay.AccountPayouts](Worldpay.AccountPayouts.md): Worldpay **Account Payouts API** — push funds to bank accounts.

  - [Worldpay.CardPayouts](Worldpay.CardPayouts.md): Worldpay **Card Payouts API** — push funds to Visa / Mastercard cards.
  - [Worldpay.FX](Worldpay.FX.md): Worldpay **FX API** — Multi-Currency Processing.
  - [Worldpay.MoneyTransfers](Worldpay.MoneyTransfers.md): Worldpay **Money Transfers API** — Original Credit Transactions (OCTs).

- Access — Data
  - [Worldpay.AccountUpdater](Worldpay.AccountUpdater.md): Worldpay **Account Updater** — keep stored card credentials current.
  - [Worldpay.CardBIN](Worldpay.CardBIN.md): Worldpay **Card BIN API** — issuer, scheme, and capability lookup.
  - [Worldpay.PaymentQueries](Worldpay.PaymentQueries.md): Worldpay **Payment Queries API** — query payment history.

- Access — Finance
  - [Worldpay.AccountTransfers](Worldpay.AccountTransfers.md): Internal fund transfers between virtual balance accounts.
  - [Worldpay.Balances](Worldpay.Balances.md): Query virtual account balances.
  - [Worldpay.Statements](Worldpay.Statements.md): Retrieve settlement statements (deposit summaries).

- Marketplace
  - [Worldpay.Marketplaces.Parties](Worldpay.Marketplaces.Parties.md): Worldpay **Parties API** — onboard and manage marketplace sellers.
  - [Worldpay.Marketplaces.SplitPayments](Worldpay.Marketplaces.SplitPayments.md): Worldpay **Split Payments API** — allocate a payment across balance accounts.

- WPG (Legacy Gateway)
  - [Worldpay.WPG](Worldpay.WPG.md): Worldpay **WPG (Worldpay Payment Gateway)** — XML-based gateway client.
  - [Worldpay.WPG.Builder](Worldpay.WPG.Builder.md): Builds WPG XML request documents.
  - [Worldpay.WPG.Parser](Worldpay.WPG.Parser.md): Parses WPG XML responses into string-keyed maps.

- Schemas
  - [Worldpay.Schema.Address](Worldpay.Schema.Address.md): Billing or shipping address.
  - [Worldpay.Schema.Amount](Worldpay.Schema.Amount.md): Monetary amount with currency.
  - [Worldpay.Schema.CustomerAgreement](Worldpay.Schema.CustomerAgreement.md): Stored credential agreement types:
`:card_on_file` | `:subscription` | `:installment` | `:unscheduled`

  - [Worldpay.Schema.FundsTransfer](Worldpay.Schema.FundsTransfer.md): Account Funding Transaction (AFT) metadata.
  - [Worldpay.Schema.Merchant](Worldpay.Schema.Merchant.md): Merchant entity reference, including optional PayFac data.
  - [Worldpay.Schema.Narrative](Worldpay.Schema.Narrative.md): Statement narrative (merchant descriptor on card statement).
  - [Worldpay.Schema.PaymentInstrument](Worldpay.Schema.PaymentInstrument.md): Payment instrument variants.
  - [Worldpay.Schema.ThreeDS](Worldpay.Schema.ThreeDS.md): 3DS authentication result to attach to a payment.

- Errors
  - [Worldpay.Error](Worldpay.Error.md): Structured error returned from all Worldpay API calls.

- Telemetry
  - [Worldpay.Telemetry](Worldpay.Telemetry.md): Telemetry integration for all Worldpay API calls.