Check Emi
This API can be used to -
Get the EMI offers as shared by Issuer bank
Get foreclose details for a converted EMI.
Process ParametersRequestResponserequestId *StringMandatoryUnique uuid-v4 string
Example: abcd-12345-abcd-12345
service *StringMandatoryValue: in.juspay.hyperapi
payload *StringMandatoryParameters required to call Hyper SDK API
action *StringMandatoryOperation to be performed in the SDK.
Example:- upiCheckEmi
upiRequestId *StringMandatoryRequest id for upi transaction
emiTxnType *StringMandatoryEMI transaction Conversion types
Example:- DURING,POST,FORECLOSE]
originalTxnUpiRequestId *StringMandatoryIn case of
DURING/POST: upiRequestId of the fin txn which is to be converted to EMI,FORECLOSE: upiRequestId of the SELECT call through which fin txn was converted to EMI . (35 character alphanumeric.)Example:- YJP1234567890qwsjpasdfghjk1234
checkEmiUpiRequestIdStringConditionalupiRequestId of EMI CHECK api call .35 character alphanumeric. Required when
emiTxnType!=DURING(Brand Funded scenario)Example:- YJPr4r4r467890qwsjpasdfghjk1234
originalTxnAmt *StringMandatoryAmount of the original transaction which is to be converted to EMI.
Example:- 1000.00
originalTxnTsStringConditionalTimestamp of the original transaction. String (
YYYY-MM-DDTHH:MM:SS+05:30). Required whenemiTxnType=POSTExample:- 1750397231000
customerVpa *StringMandatoryVpa of the customer/payer to be used for emi conversion payment.
Example:- xxx@ypay
accountReferenceIdStringOptionaLpayeeVpa *StringMandatoryVpa of the payee to whom money is being sent for emi conversion payment
Example:- swiggytest@ypay
mcc *StringMandatoryMerchant Category Code for the merchant whose VPA is passed in payeeVpa
Example:- 5812
forecloseEmiIdJson StringConditionalemiId of the converted EMI that is to be foreclosed. Required when
emiTxnType=FORECLOSEExample:- Ahask1a2908395239df56663244f8c7deef
udfParametersJson StringoptioanlStringified JSON for udf parameters
signature *StringMandatoryBase 64 encoding of signaturePayload and Protected .
protected *StringMandatoryBase 64 encoding of the below parameters.
kid *StringMandatoryKey ID to identify the public-private key pair used for signature generation. It will be provided to you by the Juspay team.
Example: uat833359804655bb748702e324111
Alg *StringMandatoryAsymmetric algorithm used. Will be RS256 in this case..
Example:- RS256
signaturePayload *StringMandatorySignature payload is a stringified JSON of the details mentioned in the below table.
merchantCustomerId *StringMandatoryMerchant generated unique profile id for the customer.
merchantId *StringMandatoryUnique identifier associated with an account created by juspay.Ex: stock
merchantChannelId *StringMandatoryAs provided by Juspay.
timestamp *StringMandatoryTime when request is created in milliseconds.