Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Introduction
This article serves as an integration guide for developers/product managers of any business who wishes to use Sodexo and Zeta money as a payment instrument on their user payment flows.
Note |
---|
Payment exceptions occur when an API operation fails to process a request payload. See Error Codes to know more about exception response codes. |
Terminology Used
Entity | Description |
---|---|
User | The customer who purchases products on the e-commerce application. |
Merchant | The Sodexo merchant whose products are being purchased. |
Requester | A merchant aggregator who sells goods/services of Sodexo acquired merchants and requests transactions on merchant’s behalf. |
Integration Methods
The Sodexo E-Com integration involves the checkout flow and save card flow. The details of each flow is described below.
Checkout Flow
User adds items to the cart on the e-commerce application and goes to the checkout page.
User clicks on PayWithSodexo option for the payment.
The requester’s/merchant’s web site shows below payment options to the user:
Saved Sodexo card
Checkout with a new card
Note The flow remains the same for both options except for the fact that user needs to enter the card details if he/she chooses to go with the "checkout with a new card" option.
Let’s assume user chooses to go with "checkout with a new card" option.
The requester’s/merchant's server makes a "Create a Transaction" call to Zeta and in return gets
redirectUserTo
URL (a Zeta domain secured page where user completes the authorization of the transaction) including other details mentioned in API response.
The authorization step is completed in Zeta’s secured domain.In case of Saved Card: the "Create a Transaction" call needs an extra parameter of
sourceId
to be provided. ThissourceId
is an identifier available with the requester.In case of a New Card: the "Create a Transaction" call will have
sourceId
as nullThe requester/merchant redirects the user to "
redirectUserTo
" page to complete the authorization.The user enters the card number, CVV and expiry date. User also chooses whether to allow saving of the card for the convenience of future transactions. See the mobile/web flow below:
User gets redirected to Access Control Server (ACS ) page in Zeta domain where he/she is prompted to enter the card/super card PIN based on the issuer of the card. User enters the PIN and submits it. This step completes the transaction authorization. See the mobile/web flow below:
Based on authorization success or failure the user gets redirected to requester’s/merchant’s
successUrl
orfailureUrl
. See the mobile/web flow of success and failure scenarios below:
In above redirection, the requester gets the "q=<xxxxx>" as a query parameter. The requester/merchant calls "Get Transaction Details" API to validate the transaction state and transaction amount for the transaction created with
requestId
= xxxxx.Note If the user has chosen to "save the card" in step 6 "Get Transaction Details" response will also return the
sourceId
that can be saved and used in future transactions.After successful validation, the merchant/requester should consider the transaction is completed.
Save Card Flow
Note |
---|
Save card flow debits Rs 0.01 from the user’s account. |
User clicks on "Save Sodexo Card" button on merchant’s/requester’s website.
The merchant’s/requester’s server makes a ‘Save a Card’ API call and in return gets
redirectUserTo
URL (a Zeta domain secured page where user completes the card authentication process) .The requester/merchant redirects the user to "
redirectUserTo
" page.The user enters the card number, cvv2 and expiry date.
User gets redirected to ACS page where he/she is prompted to enter the card/super card PIN based on the issuer of the card. User enters the PIN and submits it. This step completes the authentication.
Based on authentication success or failure the user gets redirected to requester’s/merchant’s
successUrl
orfailureUrl
.In above redirection, the requester gets the ‘q=<xxxxx>’ as a query parameter. The requester/merchant calls "Get Transaction Details" API with
requestId
= xxxxx.
This returns thesourceId
which can be saved for future to get the maskedPan details, balance and other info by calling the "Get a Source" API.
Note |
---|
Save card flow debits Rs 0.01 from the user’s account. |
Panel | ||||||
---|---|---|---|---|---|---|
|