Merchant needs to created order(API Reference
) with Juspay before initiating transaction.
Check for Eligibility of customer and merchant before initiating LOYLTYREWARDZ transaction
Eligibility
To initiate LOYLTYREWARDZ transaction merchant and customer both needs to be eligible.
Customer Eligibility
To verify Customer Eligibility Merchant needs to call cardBin API or ListCard API.
If a user has made a Successful Card Transaction earlier on the merchant app, and if they have opted to “Securely save the card for future Payments”(saved card) then merchant can call List Card API.
If user has no saved card with merchant then merchant should call CardBin API.
List Card API (API Reference)
If response of List card contain reward_supported (cards[].reward_supported) as True and reward_supported_gateway(cards[].reward_supported_gateway) has LOYLTYREWARDZ present then customer is eligible for LOYLTYREWARDZ transaction with that card.
CardBin API (API Reference)
If response of List card contain reward_supported as True and reward_supported_gateway has LOYLTYREWARDZ present then customer is eligible for LOYLTYREWARDZ transaction with that card.
Merchant Eligibility
To verify Merchant Eligibility Merchant needs to call MPM API or SPM API.
SPM API (API Reference)
Merchant is eligible If the response of SPM API call contain paymentMethod(merchantPaymentMethods[].paymentMethod) as LOYLTYREWARDZ.
MPM API (API Reference)
Merchant is eligible If the response of MPM API call contain payment_method(payment_methods[].payment_method) as LOYLTYREWARDZ.
After Eligibility check merchant needs to fetch reward balance for customer. On the basis of reward balance transaction flow will be decided.
Reward Balance
To fetch reward balance merchant should call CardsBalance API
Card Balance API (API Reference)
If the response should contain is_eligible as True and reward_details and balance.
If the balance >= invoice_amount then merchant should initiate Reward Transaction Flow.
If balance < invoice_amount then merchant should initiate Card+Reward Transaction Flow.
Transaction
Merchant need to create order. Post that merchant will be able to initiate transaction.
To initiate Transaction merchant needs to call /txns API. Request and response will be based on transaction flow.
Reward Transaction (API Reference)
Merchant should call /txns API with reward_details (from Reward Balance in stringify format), mobile_number (linked mobile number with card).
LOYLTYREWARDZ will generate OTP and send it to customer’s mobile_number provided in /txns request.
To submit the OTP, merchant can opt for JUSPAY’s OTP page or merchant’s OTP page.
If merchant opts for JUSPAY’s OTP page then merchant needs to redirect user to given url (payment.authentication.url) from response and it will open submit OTP page and after submission user will be redirected to the merchant’s provided return_url in order create request.
If merchant opts for own submit OTP page than merchant needs to call /authenticate API with OTP, challenge_id (payment.authentication.params.challenge_id) and txn_uuid. These values will be present in /txns response. After successful response from /authenticate API merchant needs to redirect user to respective return url.
Card + Reward Transaction (API Reference)
Merchant should call /txns API with primary payment instrument(parent transaction) as Card and secondary payment instrument(child transaction) as LOYLTYREWARDZ.
Parent card transaction can be New/Token/Saved Card Transaction below API reference is for new card transaction.
Use additional_payment_details to pass details of child transaction.
additional_payment_details.reward_details should contain reward_details (from Reward Balance in stringify format).
additional_payment_details.split_amount should contain balance (from Reward Balance).
additional_payment_details.mobile_number should contain link mobile number.
Response will contain URL on which merchant needs to redirect User. This URL will process parent transaction and after successful parent transaction it will initiate LOYLTYREWARDZ transaction.
LOYLTYREWARDZ transaction will be direct debit, because customer has been authenticated with successful parent transaction.
After LOYLTYREWARDZ transaction customer will be redirected to the merchant’s provided return_url in order create request.
Order Status
After completion of Transaction, Merchant should call Order status API to fetch status of transaction.
All the API call will needs Authorization Header
Authorization Header
Base64 Encoded Username:Password
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
