Skip to content

Payments API - sequence diagrams

Below are some common flows when using the Payments API.

For greater control of the payment flow, view the sequence diagrams for our Modular APIs.

Diagrams: Guest Card Payment

A basic card payment with no additional features such as 3DS or FraudSight enabled.

BrowserMerchant FrontendMerchant BackendPayments APIIssuerOrder receipt pageClick PayPayPayment requestAuthorization RequestAuthorization ResponsePayment responseSettlements requestSettlements responseTransaction completeBrowserMerchant FrontendMerchant BackendPayments APIIssuer

Diagrams: FraudSight

Card payment with FraudSight enabled that results in a highRisk assessment outcome that stops the payment.

BrowserMerchant FrontendMerchant BackendPayments APIoutcome: highRisk Payment stoppedTransaction FailedClick PayPayPayment requestfraud assessmentPayment responseTransaction FailedBrowserMerchant FrontendMerchant BackendPayments API

Diagrams: 3DS

Card payment with 3DS authentication enabled, resulting in a frictionless issuer response.

BrowserMerchant FrontendMerchant BackendPayments APIIssuerOrder receipt pageClick PayPayPayment requestPayment responseDeviceData - BIN/JWT/URL3DS Device Data formForm postPostMessage: dfReferenceId3dsDeviceData requestAuthorization RequestAuthorization Response3dsDeviceData responseSettlements requestSettlements responseTransaction completeBrowserMerchant FrontendMerchant BackendPayments APIIssuer

Diagrams: SCA Exemptions

Exemption granted with a placement of authorization and is honored by the issuer (payment authorized)

BrowserMerchant FrontendMerchant BackendPayments APIIssuerExemption granted Placement: authorization Type: lowRisk or lowValueExemption honored payment authorizedOrder receipt pageClick PayPayPayment requestExemption AssessmentAuthorization RequestAuthorization ResponsePayment responseSettlements requestSettlements responseTransaction completeBrowserMerchant FrontendMerchant BackendPayments APIIssuer

Diagrams: Storing credentials for future CIT

Setup a customerAgreement to store credentials for future CIT payments. Create a Worldpay Token in order to store the credentials. For SCA or 3DS mandated countries 3DS authentication should also take place.

BrowserMerchant FrontendMerchant BackendPayments APIIssuerSet customerAgreement type: cardOnFile storedCardUsage: firstSet tokenCreation.type: worldpaypayment authorizedWorldpay Token providedOrder receipt pageClick PayPayPayment requestPayment responseDeviceData - BIN/JWT/URL3DS Device Data formForm postPostMessage: dfReferenceId3dsDeviceData request3dsDeviceData responseChallenge JWT/URL3DS challenge formForm postReturn to merchant site3dsChallenges requestAuthorization RequestAuthorization Response3dsChallenges responseSettlements requestSettlements responseTransaction completeBrowserMerchant FrontendMerchant BackendPayments APIIssuer

Diagrams: Storing credentials for future MIT

Setup a customerAgreement to store credentials for future MIT payments. Create a Worldpay Token in order to store the credentials. For SCA or 3DS mandated countries 3DS authentication should also take place and have the challenge.preference set to challengeMandated.

BrowserMerchant FrontendMerchant BackendPayments APIIssuerSet customerAgreement type: subscription storedCardUsage: firstSet threeDS.challenge preference: challengeMandatedSet tokenCreation.type: worldpaypayment authorizedWorldpay Token providedOrder receipt pageClick PayPayPayment requestPayment responseDeviceData - BIN/JWT/URL3DS Device Data formForm postPostMessage: dfReferenceId3dsDeviceData request3dsDeviceData responseChallenge JWT/URL3DS challenge formForm postReturn to merchant site3dsChallenges requestAuthorization RequestAuthorization Response3dsChallenges responseSettlements requestSettlements responseTransaction completeBrowserMerchant FrontendMerchant BackendPayments APIIssuer