JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Loyalty Rewardz Onboarding and Payload Specifications

Pre-Requisites

Sample Requests and Responses

—> getPaymentMethods

Sample Response

—> listCard (To Check Eligibility for Saved Cards)

Sample Payload

Sample Response

—> cardInfo (To Check Eligibility for New Cards)

Sample Payload

Sample Response

—> fetchBalance

Sample Payload

Sample Response

—> transaction (Full Redemption)

(If balance is equal to invoice amount)

Sample Payload

Sample Response

—> transaction (Split)

(If balance is less than invoice amount)

Sample Payload

Sample Response

—> Order Status

With the existing implementation on Juspay , the transaction level details are available in the root structure of the orderStatus(/orders/:order_id) JSON block.

AUTO_REFUNDED
- New status AUTO_REFUNDED, which indicates than primary card transaction is successful but the LOYLTYREWARDZ transaction got failed and JUSPAY has called Auto Refund for primary card transaction.
PARTIAL_CHARGED
- New status PARTIAL_CHARGED, which indicates than primary card transaction is successful but the LOYLTYREWARDZ transaction is in PENDING state.
- If LOYLTYREWARDZ transaction get failed then JUSPAY will auto refund Card transaction.
- If LOYLTYREWARDZ transaction get successful then JUSPAY will mark status as CHARGED.
Only incase of split transactions, orderStatus response will return txn_list as an array block in with the 2 transactions (CARD + LOYLTYREWARDZ). You need to make sure to consume the params from inside the txn_list array block.
As orderStatus response is changing incase of split transaction and AUTO_REFUNDED / PARTIAL_CHARGED case, It will also effect webhook payload (If already handled no need for any change).

Sample Request

Sample Response (Full Redemption)

Sample Response (Split)

—> Refunds

Refund Cases

Refund requests (full/partial) can be initiated by a Juspay’s merchant at Transaction level or at Order level.

2. Given that LOYLTYREWARDZ transactions can be split between an existing Gateway and LOYLTYREWARDZ, the merchant can choose between one of the two provisions -

3. For Order based refunds,

merchant will have to pass order_id & amount (refund amount) to Juspay.
Order may have 2 transactions (Card and LOYLTYREWARDZ), Juspay will try to prioritise card transaction for refund and if the refund amount is greater than card transaction amount then JUSPAY will initiate refund call to LOYLTYREWARDZ.
In case refund amount is lower than card transaction amount than merchant will receive refund response similar to transaction id based refund response
Merchant will receive Juspay’s refund response accordingly (post PG processing) and is expected to handle the same (new key “split_refund_details”)

4. For Transaction based refunds

merchant would initiate refunds against all transaction Ids, with transaction Id and amount to Juspay
Merchant will ensure the amount checks and the refund split for both full and partial refunds.
Juspay’s refund response will remain the same as what merchants currently see for transaction based refunds. No additional handling required.

Loyalty Rewardz Onboarding and Payload Specifications

Pre-Requisites

Sample Requests and Responses

—> getPaymentMethods

Sample Response

—> listCard (To Check Eligibility for Saved Cards)

Sample Payload

Sample Response

—> cardInfo (To Check Eligibility for New Cards)

Sample Payload

Sample Response

—> fetchBalance

Sample Payload

Sample Response

—> transaction (Full Redemption)

Sample Payload

Sample Response

—> transaction (Split)

Sample Payload

Sample Response

—> Order Status

Sample Request

Sample Response (Full Redemption)

Sample Response (Split)

—> Refunds

—> Order Based Refunds

Sample Request

Sample Response

—> Transaction Based Refunds

Sample Request

Sample Response