Take a Payment

Modular APIs

Benefit from more control with our modular APIs. Perform a single risk check when using multiple payment providers, use our 3DS API as a standalone product or tailor your payment journey based on your business needs.

Not sure where to start? Use the sequence diagrams to help you understand the different combination of services you could use to integrate. Or use the smart journey demo tool to see a real example in action.

Smart Journey Demo

Explore our interactive demo to see how to make our APIs work for your business.

Sequence diagrams

View sequence diagrams to understand how common Payments API flows would integrate with your application.

You can use a combination of the APIs from our catalogue to create flows:

Card Payments

3DS

FraudSight

Tokens

SCA Exemptions

Card Verifications

Verified Tokens

View all APIs

Sequence Diagrams

For a simplified integration, view the sequence diagrams for our orchestration Payments API.

Guest card payment

Card payment using Card Payments API only.

Using:

  1. Card Payments API
BrowserMerchant_FrontendMerchant_BackendCard_Payments_APIClick PayPaycustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseBrowserMerchant_FrontendMerchant_BackendCard_Payments_API

SCA Exemptions & 3DS

Please note that exemptions in authentication (3DS) is not yet available.

Exemptions request with a placement in authorization

Using:

  1. Exemptions API
  2. Card Payments API
BrowserMerchant_FrontendMerchant_BackendCard_Payments_APIExemptions_APIIssuersExemption (e.g.lowRisk/authorization) / Apply riskProfile in Card PaymentsExemption honoured by the issuerClick PayPayAssessment requestAssessment responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseBrowserMerchant_FrontendMerchant_BackendCard_Payments_APIExemptions_APIIssuers

Checkout

Card payment via the Checkout SDK, including the creation of a verified token.

Using:

  1. Checkout SDK
  2. Verified Token
  3. Card Payments API
BrowserMerchant_FrontendMerchant_BackendCheckout_SessionsVerified_Token_APICard_Payments_APICheckout JS added to pageIncludes SessionIncludes tokenClick PayCreate sessionReturn sessionPayVerified token requestVerified token responsecustomerInitiatedTransactions requestcustomerInitiatedTransactions responseSettlement requestSettlement responseBrowserMerchant_FrontendMerchant_BackendCheckout_SessionsVerified_Token_APICard_Payments_API

Payment with stored card

Creating a token, authentication using 3DS and using the token as part of a card payment.

For use with future Customer Initiated Payments (CIT)

Using:

  1. Tokens API
  2. 3DS API
  3. Card Payments API
BrowserMerchant_FrontendMerchant_BackendCard_Payments_APITokens_API3DS_APIIssuersIncludes tokenIncludes TokenUpdate or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcIncludes tokenClick PayPayTokens requestTokens 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 responseBrowserMerchant_FrontendMerchant_BackendCard_Payments_APITokens_API3DS_APIIssuers

Recurring Payments

Request 3DS authentication with the challenge set as mandated for SCA compliance. Send a card payments Customer Initiated Transaction (CIT) request.

Using:

  1. 3DS API
  2. Card Payments API
BrowserMerchant_FrontendMerchant_Backend3DS_APICard_Payments_APIIssuersSet `challenge.preference.challengeMandated`Update or close challenge window on websiteApply authentication details in payment E.g. eci, authenticationValue etcSet `customerAgreement.type.subscription` `customerAgreement.storedCardUsage.first`Click 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 responseBrowserMerchant_FrontendMerchant_Backend3DS_APICard_Payments_APIIssuers