Payments API - Sequence Diagrams

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

Below are some common flows when using the Payments API.

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

BrowserMerchant_FrontendMerchant_BackendPayments_APIIssuersOrder receipt pageClick PayPayPayment requestPayment responseSettlements requestSettlements responseTransaction completeBrowserMerchant_FrontendMerchant_BackendPayments_APIIssuers

Enabling 3DS and FraudSight

Card Payment with FraudSight enabled that results in a highRisk assessment outcome.

BrowserMerchant_FrontendMerchant_BackendPayments_APIIssuersTransaction FailedClick PayPayPayment requestPayment response (Fraud: highRisk)Transaction FailedBrowserMerchant_FrontendMerchant_BackendPayments_APIIssuers

Storing Card Details / Recurring

Card payment that both creates a customer agreement for a subscription payment and uses 3DS authentication, resulting in a challenged issuer response.

BrowserMerchant_FrontendMerchant_BackendPayments_APIIssuersSet `challenge.preference = challengeMandated`Set `customerAgreement.type.subscription` `customerAgreement.storedCardUsage.first`Order receipt pageClick PayPayPayment requestPayment responseDeviceData - BIN/JWT/URL3DS Device Data formForm postPostMessage: dfReferenceId3dsDeviceData request3dsDeviceData responseChallenge JWT/URL3DS challenge formForm postReturn to merchant site3dsChallenges request3dsChallenges responseSettlements requestSettlements responseTransaction completeBrowserMerchant_FrontendMerchant_BackendPayments_APIIssuers