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.
A basic card payment with no additional features such as 3DS or FraudSight enabled.
Card payment with FraudSight enabled that results in a highRisk assessment outcome that stops the payment.
Card payment with 3DS authentication enabled, resulting in a frictionless issuer response.
Setup a customerAgreement to store credentials for future CIT payments.
- Set the
customerAgreement.typetocardOnFileandstoredCardUsagetofirst - Set
tokenCreation.typetoworldpayin order to store the credentials. - The example includes 3DS for SCA or 3DS mandated countries
- If no initial payment is to be made (e.g. free trial), set the
value.amountto0. A card verification is performed instead.
Using a previously stored card to make a payment
Setup a customerAgreement to store credentials for future MIT payments.
- Set the
customerAgreement.typetosubscriptionandstoredCardUsagetofirst - Set
tokenCreation.typetoworldpayin order to store the credentials. - The example includes 3DS for SCA or 3DS mandated countries and has the
threeDS.challenge.preferenceset tochallengeMandated. - If no initial payment is to be made (e.g. free trial), set the
value.amountto0. A card verification is performed instead.
Send a Merchant Initiated Transaction (MIT) request for subsequent recurring transactions.