{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":["admonition","tabs","tab"]},"type":"markdown"},"seo":{"title":"Sequence diagrams - Stored card using Network Payment Tokens | Worldpay Developer","description":"Sequence diagrams for common Stored card flows using Network Payment Tokens (NPT)","siteUrl":"https://docs.worldpay-bsh.securedataplatform.co.uk","image":"/access/assets/worldpay-logo-light.21b7daf79984773a9fcd7d4fbcb07ae5289dfffd6023c4c3dca720c7058e53dc.33f780a6.svg","keywords":"documentation, api, openapi, sdks, developer, payments, json, payouts, 3ds","jsonLd":{"@context":"https://schema.org","@type":"Organization","url":"https://docs.worldpay-bsh.securedataplatform.co.uk/access","name":"Worldpay"},"meta":[{"name":"google-site-verification","content":"zjziIKaP3ImsqsfhYnEBnq1R85UabiSwl7HTXuwtZuo"},{"name":"doc_product","content":"Access"},{"name":"doc_category","content":"Documentation"}],"llmstxt":{"hide":false,"sections":[{"title":"Payments API","description":"Payment orchestration API combining fraud assessment, 3ds authentication, SCA exemptions, Worldpay Token creation and a card or wallet based payment.","includeFiles":["products/payments/@20240601/**/*"]},{"title":"Payment Queries API","description":"Querying your payments data, based on a variety of parameters.","includeFiles":["products/payment-queries/@v1/**/*"]},{"title":"Card BIN Data API","description":"Provides detailed information about a card.","includeFiles":["products/card-bin/@v1/**/*"]},{"title":"3DS Authentication API","description":"Request 3DS authentication to protect against fraud, be SCA compliant and to shift liability using this standalone API.","includeFiles":["products/3ds/@v3/**/*"]},{"title":"FraudSight API","description":"Request a risk assessment and receive a response with an outcome (e.g. lowRisk) using this standalone API.","includeFiles":["products/fraudsight/@v1/**/*"]},{"title":"Checkout SDK","description":"Integrate using our clientside SDKs for both web and native devices. Benefit from SAQ-A/PCI-SSF compliance.","includeFiles":["products/checkout/web/@v2/**/*","products/checkout/ios/@v4/**/*","products/checkout/android/@v4/**/*","products/checkout/react-native/@v3/**/*","products/checkout/flutter/@v1/**/*"]},{"title":"Tokens API","description":"Minimizes the exposure of sensitive card details and increases the security of your customer's card details.","includeFiles":["products/tokens/@v3/**/*"]},{"title":"Card Payments API","description":"Request a card payment using this standalone API, requires separate requests for 3DS, Fraud assessment etc.","includeFiles":["products/card-payments/@v7/**/*"]},{"title":"Card Verifications API","description":"Verify your customer's card to maximize your authentication rates.","includeFiles":["products/card-verifications/@v6/**/*"]},{"title":"Account Payouts API","description":"Send funds to your customer's bank accounts and search for payouts using parameters.","includeFiles":["products/account-payouts/@20250101/**/*"]},{"title":"APMs","description":"Pay using eWallets, bank transfers, direct debits, local card schemes, Postpay and eInvoice/ Buy Now Pay Later.","includeFiles":["products/apms/@20240701/**/*"]},{"title":"Balance API","description":"Request your account details for a single account or all accounts under an entity.","includeFiles":["products/balance/@20250101/**/*"]},{"title":"Card Payouts API","description":"Send funds to your customer's cards.","includeFiles":["products/card-payouts/@v4/**/*"]},{"title":"Events (Webhooks)","description":"Receive status updates from Access Worldpay by setting up a webhook.","includeFiles":["products/events/@v1/**/*"]},{"title":"FX API","description":"Manage Foreign Exchange (FX) on your payments.","includeFiles":["products/fx/@v1/**/*"]},{"title":"Hosted Payment Pages (HPP) API","description":"Our low-code option to take payments securely at the lowest PCI compliance level - SAQ A.","includeFiles":["products/hosted-payment-pages/@v1/**/*"]},{"title":"Money Transfers API","description":"Money Transfer OCTs (Original Credit Transaction) allow funds to be pushed to an eligible card in 30 minutes or less.","includeFiles":["products/money-transfers/@v1/**/*"]},{"title":"Parties API","description":"Create parties, manage your payout instruments and beneficial owners and carry out identity verification checks.","includeFiles":["products/parties/@20250101/**/*"]},{"title":"SCA Exemptions API","description":"Maximize a frictionless checkout experience by using issuer data insights to apply exemptions.","includeFiles":["products/sca-exemptions/@v1/**/*"]},{"title":"Split Payments API","description":"Divide funds from a single payment amongst yourself and your parties/sellers.","includeFiles":["products/split-payments/@20250625/**/*"]},{"title":"Statements API","description":"Retrieve your account statement and see individual entries for all credits and debits.","includeFiles":["products/statements/@20250101/**/*"]},{"title":"Transfers API","description":"Transfer funds from source account to target account.","includeFiles":["products/transfers/@20250101/**/*"]},{"title":"Verified Tokens API","description":"Verified Tokens ensures that your customer's payment details are valid and CIT compliant when creating a token.","includeFiles":["products/verified-tokens/@v3/**/*"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/modular"},"children":["<< Back to Modular Home"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"sequence-diagrams---stored-card-using-a-network-token","__idx":0},"children":["Sequence diagrams - stored card using a Network Token"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"customer-initiated-transactions-cits","__idx":1},"children":["Customer Initiated Transactions (CITs)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can create the Network Payment Token (NPT) either before the initial plain card or Worldpay token payment is made, or after the payment. Examples of both are below:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-an-npt-cit---before-payment","__idx":2},"children":["Creating an NPT (CIT) - before payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create an NPT before the payment using either API only or the Checkout SDK."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["As NPT creation is not guaranteed you must have a fallback to a Worldpay Token."]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Using Checkout SDK","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment via the Checkout Web SDK, including the creation of a verified token and a Network Payment Token (before payment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/checkout/"},"children":["Checkout SDK"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/verified-tokens/"},"children":["Verified Token API"]}," - for Worldpay Token creation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to convert the Worldpay token to a network token"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`
`customerAgreement.storedCardUsage: first` / Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n","diagramHtml":"Card_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedSet `customerAgreement.type: cardOnFile` `customerAgreement.storedCardUsage: first` / Includes Network Payment Token (NPT) number and cryptogramClick PayCreate sessionReturn sessionPayVerified token requestVerified token responseCreate NPTCreate NPT responseProvision cryptogram for NPTProvision cryptogram responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response","diagramHtmlDark":"Card_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedSet `customerAgreement.type: cardOnFile` `customerAgreement.storedCardUsage: first` / Includes Network Payment Token (NPT) number and cryptogramClick PayCreate sessionReturn sessionPayVerified token requestVerified token responseCreate NPTCreate NPT responseProvision cryptogram for NPTProvision cryptogram responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`
`customerAgreement.storedCardUsage: first` / Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n"]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Using Checkout SDK (includes 3DS)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment via the Checkout Web SDK and 3DS authentication, including the creation of a verified token and a Network Payment Token (before payment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/checkout/"},"children":["Checkout SDK"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/verified-tokens/"},"children":["Verified Tokens API"]}," - covert the session in to a Worldpay Token"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to convert the Worldpay token to an NPT"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds/"},"children":["3DS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Note left of Merchant_Backend: If NPT creation fails/is slow/not supported use the Worldpay Token instead
Proceed to the 3DS steps\n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n","diagramHtml":"IssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedIf NPT creation fails/is slow/not supported use the Worldpay Token instead Proceed to the 3DS stepsIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedIncludes Network Payment Token (NPT) numberIncludes Network Payment Token (NPT) numberUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Network Payment Token (NPT) number and cryptogramClick PayCreate sessionReturn sessionPayVerified token requestVerified token responseCreate NPTCreate NPT responseProvision cryptogram for NPTProvision cryptogram responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response","diagramHtmlDark":"IssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedIf NPT creation fails/is slow/not supported use the Worldpay Token instead Proceed to the 3DS stepsIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedIncludes Network Payment Token (NPT) numberIncludes Network Payment Token (NPT) numberUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Network Payment Token (NPT) number and cryptogramClick PayCreate sessionReturn sessionPayVerified token requestVerified token responseCreate NPTCreate NPT responseProvision cryptogram for NPTProvision cryptogram responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Note left of Merchant_Backend: If NPT creation fails/is slow/not supported use the Worldpay Token instead
Proceed to the 3DS steps\n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n"]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"API only","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment including the creation of a Network Payment Token (before payment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to create an NPT (from plain card or existing worldpay token)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using Plain card or Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Note left of Merchant_Backend: Note: If NPT creation fails, use Tokens API to create a Worldpay Token\n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n","diagramHtml":"Card_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing Plain card or Worldpay TokenNetwork Payment Token (NPT) number returnedNote: If NPT creation fails, use Tokens API to create a Worldpay TokenIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Network Payment Token (NPT) number and cryptogramClick PayPayCreate NPTCreate NPT responseProvision cryptogram for NPTProvision cryptogram responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response","diagramHtmlDark":"Card_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing Plain card or Worldpay TokenNetwork Payment Token (NPT) number returnedNote: If NPT creation fails, use Tokens API to create a Worldpay TokenIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Network Payment Token (NPT) number and cryptogramClick PayPayCreate NPTCreate NPT responseProvision cryptogram for NPTProvision cryptogram responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using Plain card or Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Note left of Merchant_Backend: Note: If NPT creation fails, use Tokens API to create a Worldpay Token\n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n"]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"API only (includes 3DS)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment with 3DS authentication including the creation of a Network Payment Token (before payment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to create an NPT (from plain card or existing worldpay token)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using Plain card or Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note left of Merchant_Backend: If NPT creation fails, use Tokens API to create a Worldpay Token\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Merchant_Backend->>Tokens_API: Provision Cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n","diagramHtml":"IssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing Plain card or Worldpay TokenIf NPT creation fails, use Tokens API to create a Worldpay TokenNetwork Payment Token (NPT) number returnedIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedIncludes Network Payment Token (NPT) numberIncludes Network Payment Token (NPT) numberUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Network Payment Token (NPT) number and cryptogramClick PayPayCreate NPTCreate NPT responseProvision Cryptogram for NPTProvision cryptogram responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response","diagramHtmlDark":"IssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing Plain card or Worldpay TokenIf NPT creation fails, use Tokens API to create a Worldpay TokenNetwork Payment Token (NPT) number returnedIncludes Network Payment Token (NPT) numberCryptogram for Network Payment Token (NPT) returnedIncludes Network Payment Token (NPT) numberIncludes Network Payment Token (NPT) numberUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Network Payment Token (NPT) number and cryptogramClick PayPayCreate NPTCreate NPT responseProvision Cryptogram for NPTProvision cryptogram responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using Plain card or Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note left of Merchant_Backend: If NPT creation fails, use Tokens API to create a Worldpay Token\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n Merchant_Backend->>Tokens_API: Provision Cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment Token (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"creating-an-npt-cit---after-payment","__idx":3},"children":["Creating an NPT (CIT) - after payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create an NPT after the payment using either API only or the Checkout SDK."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Using Checkout SDK","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment via the Checkout Web SDK, including the creation of a verified token and a Network Payment Token (after payment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/checkout/"},"children":["Checkout SDK"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/verified-tokens/"},"children":["Verified Tokens API"]}," - for Worldpay Token creation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to convert the Worldpay token to NPT"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Worldpay Token\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n","diagramHtml":"Card_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Worldpay TokenIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedClick PayCreate sessionReturn sessionPayVerified token requestVerified token responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response","diagramHtmlDark":"Card_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Worldpay TokenIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedClick PayCreate sessionReturn sessionPayVerified token requestVerified token responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Worldpay Token\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n"]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Using Checkout SDK (includes 3DS)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment via the Checkout Web SDK, including the creation of a verified token and an Network Payment Token (after payment). Also uses 3DS authentication."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/checkout/"},"children":["Checkout SDK"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/verified-tokens/"},"children":["Verified Tokens API"]}," - covert the session in to a Worldpay Token"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds/"},"children":["3DS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to convert the Worldpay token to an NPT"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Worldpay Token\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Worldpay Token\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Worldpay Token\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n","diagramHtml":"IssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedIncludes Worldpay TokenIncludes Worldpay TokenUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Worldpay TokenIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedClick PayCreate sessionReturn sessionPayVerified token requestVerified token responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response","diagramHtmlDark":"IssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIVerified_Token_APICheckout_SessionsMerchant_BackendMerchant_FrontendBrowserCheckout JS added to pageIncludes sessionWorldpay Token returnedIncludes Worldpay TokenIncludes Worldpay TokenUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Includes Worldpay TokenIncludes Worldpay TokenNetwork Payment Token (NPT) number returnedClick PayCreate sessionReturn sessionPayVerified token requestVerified token responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Checkout_Sessions\n participant Verified_Token_API\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Note over Merchant_Frontend: Checkout JS added to page \n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Checkout_Sessions: Create session\n Checkout_Sessions->>Merchant_Frontend: Return session \n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Verified_Token_API: Verified token request\n Note left of Verified_Token_API: Includes session \n Verified_Token_API->>Merchant_Backend: Verified token response\n Note right of Merchant_Backend: Worldpay Token returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Worldpay Token\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Worldpay Token\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Includes Worldpay Token\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Includes Worldpay Token\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n"]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"API only","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment including the creation of a Network Payment Token (after payment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to create the NPT"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note left of Card_Payments_API: Using plain card\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using plain card\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n","diagramHtml":"Card_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserCard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing plain cardUsing plain cardNetwork Payment Token (NPT) number returnedClick PayPaycustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response","diagramHtmlDark":"Card_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserCard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing plain cardUsing plain cardNetwork Payment Token (NPT) number returnedClick PayPaycustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note left of Card_Payments_API: Using plain card\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using plain card\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n"]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"API only (includes 3DS)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card payment with 3DS authentication including the creation of a Network Payment Token (after payment)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds/"},"children":["3DS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to create the NPT"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Using plain card\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Using plain card\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Using plain card\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using plain card\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n","diagramHtml":"Issuers3DS_APICard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIssuers3DS_APICard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing plain cardUsing plain cardUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Using plain cardUsing plain cardNetwork Payment Token (NPT) number returnedClick PayPaydeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response","diagramHtmlDark":"Issuers3DS_APICard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIssuers3DS_APICard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserUsing plain cardUsing plain cardUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first` Using plain cardUsing plain cardNetwork Payment Token (NPT) number returnedClick PayPaydeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseCreate NPTCreate NPT response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant Card_Payments_API\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Using plain card\n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Using plain card\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: first`
Using plain card\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n Merchant_Backend->>Tokens_API: Create NPT\n Note left of Tokens_API: Using plain card\n Tokens_API->>Merchant_Backend: Create NPT response\n Note right of Merchant_Backend: Network Payment Token (NPT) number returned \n"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"using-an-npt-cit","__idx":4},"children":["Using an NPT (CIT)"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The NPT cryptogram and number can be from a different Payment Service Provider."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Worldpay can only provision cryptograms for NPTs it has originally created."]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Using an NPT","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using an existing NPT to provision a new cryptogram and make the payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to provision the NPT cryptogram"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant Card_Payments_API\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Provision Cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n","diagramHtml":"Card_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserCard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIncludes Network Payment (NPT) numberCryptogram for Network Payment Token (NPT) returnedSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent` Includes Network Payment Token (NPT) number and cryptogramPayProvision Cryptogram for NPTProvision cryptogram responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response","diagramHtmlDark":"Card_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserCard_Payments_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIncludes Network Payment (NPT) numberCryptogram for Network Payment Token (NPT) returnedSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent` Includes Network Payment Token (NPT) number and cryptogramPayProvision Cryptogram for NPTProvision cryptogram responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant Card_Payments_API\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Provision Cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n"]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Using an NPT (includes 3DS)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using an existing NPT to provision a new cryptogram, request 3DS authentication and make the payment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/tokens/"},"children":["Tokens API"]}," - to provision the NPT cryptogram"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/3ds/"},"children":["3DS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number \n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n","diagramHtml":"IssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIncludes Network Payment (NPT) numberCryptogram for Network Payment Token (NPT) returnedIncludes Network Payment Token (NPT) numberIncludes Network Payment Token (NPT) numberUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent` Includes Network Payment Token (NPT) number and cryptogramPayProvision cryptogram for NPTProvision cryptogram responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response","diagramHtmlDark":"IssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_API3DS_APITokens_APIMerchant_BackendMerchant_FrontendBrowserIncludes Network Payment (NPT) numberCryptogram for Network Payment Token (NPT) returnedIncludes Network Payment Token (NPT) numberIncludes Network Payment Token (NPT) numberUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent` Includes Network Payment Token (NPT) number and cryptogramPayProvision cryptogram for NPTProvision cryptogram responsedeviceDataInitialization requestdeviceDataInitialization responseDeviceData - BIN/JWT/URL3DS Device Data formForm POSTPostMessage: dfReferenceIdAuthentication requestAuthentication responseChallenge JWT/URL3DS challenge formForm POST`returnUrl` specified in authentication requestVerification requestVerification responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Tokens_API\n participant 3DS_API\n participant Card_Payments_API\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Tokens_API: Provision cryptogram for NPT\n Note left of Tokens_API: Includes Network Payment (NPT) number\n Tokens_API->>Merchant_Backend: Provision cryptogram response\n Note right of Merchant_Backend: Cryptogram for Network Payment Token (NPT) returned \n Merchant_Backend->>3DS_API: deviceDataInitialization request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number \n 3DS_API->>Merchant_Backend: deviceDataInitialization response\n Merchant_Backend->>Merchant_Frontend: DeviceData - BIN/JWT/URL\n Merchant_Frontend->>Browser: 3DS Device Data form\n Browser-->>Issuers: Form POST\n Issuers-->>Browser: PostMessage: dfReferenceId\n Merchant_Backend->>3DS_API: Authentication request\n Note left of 3DS_API: Includes Network Payment Token (NPT) number\n 3DS_API->>Merchant_Backend: Authentication response\n Merchant_Backend->>Merchant_Frontend: Challenge JWT/URL\n Merchant_Frontend->>Browser: 3DS challenge form\n Browser-->>Issuers: Form POST\n Issuers-->>Merchant_Backend: `returnUrl` specified in authentication request\n Note right of Merchant_Frontend: Update or close challenge window on website\n Merchant_Backend->>3DS_API: Verification request\n 3DS_API->>Merchant_Backend: Verification response\n Note right of Merchant_Frontend: Apply authentication details in payment
E.g. eci, authenticationValue etc\n Merchant_Backend->>Card_Payments_API: customerInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: cardOnFile`, `customerAgreement.storedCardUsage: subsequent`
Includes Network Payment Token (NPT) number and cryptogram\n Card_Payments_API->>Merchant_Backend: customerInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"merchant-initiated-transactions","__idx":5},"children":["Merchant Initiated Transactions"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Subsequent Merchant Initiated Transaction (MIT)","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using an existing NPT to make a subsequent payment (MIT)"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An NPT cryptogram is not required for Merchant Initiated Transactions"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Using:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/card-payments/"},"children":["Card Payments API"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Card_Payments_API\n participant Issuers\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Card_Payments_API: merchantInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: subscription`, `customerAgreement.storedCardUsage: subsequent`
Includes Network Payment Token (NPT) number\n Card_Payments_API->>Merchant_Backend: merchantInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n","diagramHtml":"IssuersCard_Payments_APIMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_APIMerchant_BackendMerchant_FrontendBrowserSet `customerAgreement.type: subscription`, `customerAgreement.storedCardUsage: subsequent` Includes Network Payment Token (NPT) numberClick PayPaymerchantInitiatedTransactions requestmerchantInitiatedTransactions responseSettlement requestSettlement response","diagramHtmlDark":"IssuersCard_Payments_APIMerchant_BackendMerchant_FrontendBrowserIssuersCard_Payments_APIMerchant_BackendMerchant_FrontendBrowserSet `customerAgreement.type: subscription`, `customerAgreement.storedCardUsage: subsequent` Includes Network Payment Token (NPT) numberClick PayPaymerchantInitiatedTransactions requestmerchantInitiatedTransactions responseSettlement requestSettlement response"},"children":["\nsequenceDiagram\n participant Browser\n participant Merchant_Frontend\n participant Merchant_Backend\n participant Card_Payments_API\n participant Issuers\n Browser->>Merchant_Frontend: Click Pay\n Merchant_Frontend->>Merchant_Backend: Pay \n Merchant_Backend->>Card_Payments_API: merchantInitiatedTransactions request\n Note over Merchant_Backend,Card_Payments_API: Set `customerAgreement.type: subscription`, `customerAgreement.storedCardUsage: subsequent`
Includes Network Payment Token (NPT) number\n Card_Payments_API->>Merchant_Backend: merchantInitiatedTransactions response\n Merchant_Backend->>Card_Payments_API: Settlement request\n Card_Payments_API->>Merchant_Backend: Settlement response\n"]}]}]}]},"headings":[{"value":"Sequence diagrams - stored card using a Network Token","id":"sequence-diagrams---stored-card-using-a-network-token","depth":1},{"value":"Customer Initiated Transactions (CITs)","id":"customer-initiated-transactions-cits","depth":2},{"value":"Creating an NPT (CIT) - before payment","id":"creating-an-npt-cit---before-payment","depth":3},{"value":"Creating an NPT (CIT) - after payment","id":"creating-an-npt-cit---after-payment","depth":3},{"value":"Using an NPT (CIT)","id":"using-an-npt-cit","depth":3},{"value":"Merchant Initiated Transactions","id":"merchant-initiated-transactions","depth":2}],"frontmatter":{"seo":{"title":"Sequence diagrams - Stored card using Network Payment Tokens | Worldpay Developer","description":"Sequence diagrams for common Stored card flows using Network Payment Tokens (NPT)"},"markdown":{"toc":{"hide":false}},"breadcrumbs":{"hide":true}},"lastModified":"2026-05-20T16:18:49.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/modular/sequence-diagrams/stored-card-network","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}