Step 1: Setup Service
Request the Setup service before selecting the button to submit payment. Request the
Setup service separately without including other services. The Setup service response
will include a JSON Web Token (JWT) that contains credentials to create a secure channel with
the merchant. The Setup response also includes a reference ID to use during the
authentication and a URL to use when transferring the device data that is collected in
the next step.
Run the Setup service as soon as the customer enters their card number, to avoid any
delay in the customer experience. The next step in the process, device data collection,
cannot start until the Setup response is received since the response has the URL where
the device data will be sent.
Process Flow for Setup for Payer Authentication
Best Practices
This practice should be followed for this step to achieve optimal performance and to
minimize potential operating issues.
- After the customer credit card is entered, immediately begin device data collection.
Request Fields
When requesting the Setup service, you must send the customer’s card number, encrypted payment data, transient token, or a TMS token or some other equivalent of card data used by your integration. Besides the required fields, the request might also include any of these fields:
-
paymentInformation.card.numberpaymentInformation.tokenizedCard.number
-
paymentInformation.customer.customerId
-
tokenInformation.transientToken
The
paymentInformation.card.type
field is required when the card type is Cartes Bancaires, JCB, or UPI.
Important Response Fields
The response from the issuing bank might include these API fields.
-
consumerAuthenticationInformation.accessTokenis used in Step 2: Device Data Collection.
-
consumerAuthenticationInformation.deviceDataCollectionUrlis used in Step 2: Device Data Collection.
-
consumerAuthenticationInformation.referenceIdis used in Step 3: Payer Authentication Check Enrollment Service.
For further details on examples, see Use Case: Setting Up Payer Authentication.