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 you. 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.
The Setup service is used only in the
Direct API integration. The SDK integration does not use this 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 because the response has the URL where the
device data will be sent.
Best Practices
This practice should be followed so that this step achieves 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
payment information. This can be either the actual encrypted card information or a token
associated with the payment data. Besides the required fields, the request might also
include any of these fields:
- card_accountNumber
- card_accountNumber
- recurringSubscriptionInfo_subscriptionID
- tokenSource_transientToken
The
card_cardType
field is required when the card type is Cartes Bancaires, JCB,
or UnionPay International.Important Response Fields
The response from the issuing bank might include these API fields.
- payerAuthSetupReply_accessTokenis used in Step 2: Device Data Collection.
- payerAuthSetupReply_deviceDataCollectionURLis used in Step 2: Device Data Collection.
- payerAuthSetupReply_referenceIDis used in Step 3: Payer Authentication Check Enrollment Service.
For further details on examples, see Use Case:
Setting Up Payer Authentication.