post https://test.payu.in/merchant/postservice.php
API Command: get_checkout_details
The Get Checkout Details (get_checkout_details) API is a generic API using which they can get information when you create the custom checkout pages, that will contain the payment options, offers, recommendations, and downtime details. The API provides the following details:
- Payment option details: The extended details for each payment option are available for the merchant.
- Additional charges: The additional charges are configured for all payment options.
- eligibility details
- Downtime details: The downtime status of the payment options.
Environment
| Test Environment | https://test.payu.in/merchant/postservice?form=2 |
| Production Environment | https://info.payu.in/merchant/postservice?form=2 |
Sample request and response
Get Extended Payment Details
{
// Mandatory field, random id for debugging purposes only
"requestId": "12345678",
"transactionDetails": {
// Mandatory field
"amount": 12345.12
},
"useCase": {
// Returns extended information for all the payment options
// Eg. Title, EMI amount details, etc
"getExtendedPaymentDetails": true
}
}
Response
{
"status": 1,
"details": {
"paymentOptions": {
"emi": {
"all": {
"dc": {
"hasEligible": true,
"all": {
// Key is the 4 letter IFSC initials of the banks.
"UTIB": {
"title": "Axis Bank",
"shortName": "Axis",
// Minimum amount for this bank.
"minimumAmount": 1000,
// Maximum amount for this bank, null means no-limit.
"maximumAmount": null,
"eligibility": {"status": true},
"tenureOptions": {
// Key name is the value of bankcode accepted by PayU.
"AXISD03": {
"tenure": 3,
"interestRate": 10.5,
"interestCharged": 200.45,
"monthlyEmi": 400.5,
"minimumAmount": 1000,
"maximumAmount": null,
"eligibility": {"status": true},
},
"AXISD...": { "...": "..." }
}
},
"HDFC": { "...": "..." }
},
// Least amount limit of any dc emi.
"minimumAmount": 1000,
// Highest amount limit of any dc emi, null means no limit.
"maximumAmount": null
},
"cc": { "...": "..." },
"others": { "...": "..." },
"cardless": {
"hasEligible": true,
"all": {
"ZESTMON": {
"title": "Zest Money",
"shortName": "ZestMoney",
"minimumAmount": 1000,
"maximumAmount": null,
"tenureOptions": {
"ZESTMON": {
// Tenure field will be all in case tenures of an option
// not managed on PayU end.
"tenure": null,
"minimumAmount": 1000,
"maximumAmount": null,
"eligibility": {"status": true},
// interestRate, interestCharged, monthlyEmi, etc may/may
// not be present depending whether these are maintained
// at payu's end or not. Eg ZESTMON's tenures are maintained
// on the bank end only and are returned once the customer
// proceeds with this option and submits the OTP.
}
}
},
"...": { "...": "..." }
}
}
}
},
"nb": {
"all": {
// Key name is the value of bankcode accepted by PayU.
"SBIB": {
"title": "State Bank of India"
},
"ADBB": {
"title": "Andhra Bank"
},
"AXIB": {
"title": "AXIS Bank NetBanking"
},
"AXNBTPV": {
"title": "Axis NB TPV"
},
"...": { "...": "..." }
}
},
"si": {
"all": {
"ANDBENCR": {
"title": "Andhra Bank Recurring"
},
"AUBLENCR": {
"title": "AU Small Finance Bank Ltd Recurring"
},
"UTIBENCR": {
"title": "AXIS BANK Recurring"
},
"BARBENCR": {
"title": "BARB ENACH Recurring"
},
"...": { "...": "..." }
}
},
"dc": {
"all": {
"MAST": {
"title": "MasterCard Debit Cards"
},
"MASTTPV": {
"title": "MasterCard TPV Debit Cards"
},
"SMAE": {
"title": "State Bank Maestro Cards"
},
"MAES": {
"title": "Other Maestro Cards"
},
"RUPAY": {
"title": "Rupay Debit Card"
},
"...": { "...": "..." }
}
},
"cc": {
"all": {
"CC": {
"title": "Credit Card"
},
"DINR": {
"title": "Diners"
},
"RUPAYCC": {
"title": "Rupay Credit Card"
},
"...": { "...": "..." }
}
},
"lazypay": {
"all": {
"LAZYPAY": {
"title": "LazyPay"
}
}
},
"lp-emi": {
"all": {
"LP-EMI": {
"title": "LAZYPAYEMI"
}
}
},
"cash": {
"all": {
"PAYTM": {
"title": "Paytm"
},
"...": { "...": "..." }
}
},
// Similarly all the modes & payment options that are available for
// the merchant.
"...": { "...": "..." }
}
}
}
Get Additional Charges
{
"requestId": "12345678",
"transactionDetails": {
"amount": 12345.12
},
"useCase": {
"getAdditionalCharges": true
}
}
Response
{
"status": 1,
"details": {
"paymentOptions": {
"emi": {
"all": {
"dc": {
"all": {
"UTIB": {
"tenureOptions": {
"AXISD03": {
"additionalCharge": 13.37
},
"AXISD...": { "...": "..." }
}
},
"...": { "...": "..." }
}
},
"...": { "...": "..." }
}
},
"nb": {
"all": {
"SBIB": {
"additionalCharge": 0
},
"ADBB": {
"additionalCharge": 0
},
"AXIB": {
"additionalCharge": 0
},
"AXNBTPV": {
"additionalCharge": 0
},
"...": { "...": "..." }
}
},
"dc": {
"all": {
"MAST": {
"additionalCharge": 5.0
},
"MASTTPV": {
"additionalCharge": 5.0
},
"SMAE": {
"additionalCharge": 5.0
},
"MAES": {
"additionalCharge": 5.0
},
"RUPAY": {
"additionalCharge": 5.0
},
"...": { "...": "..." }
}
},
"cc": {
"all": {
"CC": {
"additionalCharge": 5.0
},
"DINR": {
"additionalCharge": 5.0
},
"RUPAYCC": {
"additionalCharge": 5.0
},
"...": { "...": "..." }
}
},
"cash": {
"all": {
"PAYTM": {
"additionalCharge": 10.5
},
"...": { "...": "..." }
}
},
// Similarly all the modes & payment options that are available for
// the merchant.
"...": { "...": "..." }
}
}
}
Get Tax Specification
{
// Mandatory field, random id for debugging purposes only
"requestId": "12345678",
"transactionDetails": {
// Mandatory field
"amount": 12345.12
},
"useCase": {
// Down Banks info will be returned only if this flag is true.
"getTaxSpecification": true
}
}
Response
{
"status": 1,
"details": {
// No change in the payment options returned or any other internal field
// due to the checkDownStatus flag.
// These will remain as it is as the remaining responses.
"paymentOptions": {
"cc": { "...": "..." },
"dc": { "...": "..." },
"...": { "...": "..." }
},
"config": {
// This object will be returned if getTaxSpecification flag is true.
// Default is the one to be applied on all modes.
// In special cases, this can also have mode level tax percent
"taxSpecification": {
"default": 18
}
}
}
}
Check Down Status
{
// Mandatory field, random id for debugging purposes only
"requestId": "12345678",
"transactionDetails": {
// Mandatory field
"amount": 12345.12
},
"useCase": {
// Down Banks info will be returned only if this flag is true.
"checkDownStatus": true
}
}
Response
{
"status": 1,
"details": {
// No change in the payment options returned or any other internal field
// due to the checkDownStatus flag.
// These will remain as it is as the remaining responses.
"paymentOptions": {
"cc": { "...": "..." },
"dc": { "...": "..." },
"nb": { "...": "..." },
"emi": { "...": "..." },
"upi": { "...": "..." },
"cash": { "...": "..." }
},
// This object will be returned if checkDownStatus flag is true.
"downInfo": {
// issuingBank contains the list of down issuing banks for the cards
"issuingBanks": ["HDFC", "AXIS", "ICICI"],
// nb/cashcard/etc all the other keys in this object contains the list of
// down ibibo codes corresponding to the modes. The remaing keys will the
// same as the ones present in the "paymentOptions" object
"nb": ["SBIB", "ANDB"],
"cash": ["PAYTM", "YESW"],
"...": ["..."]
}
}
}
emi in the paymentOptions field with filters parameter
In this example, SBI, Kotak Mahindra and ICICI Bank EMI options are filtered. For list of EMI options, refer to EMI Options for Get Checkout Details API.
{
"requestId": "4NQD7jcrGCt2LAxB",
"filters": {
"paymentOptions": {
"emi": {
"dc": "SBIN,KKBK,ICIC"
}
}
},
"useCase": {
"checkCustomerEligibility": true
},
"customerDetails": {
"mobile": "9871732405"
},
"transactionDetails": {
"amount": "12386.00"
}
}
Response
{
"status": 1,
"details": {
"paymentOptions": {
"emi": {
"all": {
"dc": {
"all": {
"SBIN": {
"tenureOptions": {
"SBID12": {
"tenure": 12,
"eligibility": {
"status": true
}
},
"SBID18": {
"tenure": 18,
"eligibility": {
"status": false,
"reason": "Minimum required amount is 25000"
}
},
"SBID24": {
"tenure": 24,
"eligibility": {
"status": false,
"reason": "Minimum required amount is 25000"
}
},
"SBID03": {
"tenure": 3,
"eligibility": {
"status": true
}
},
"SBID30": {
"tenure": 30,
"eligibility": {
"status": false,
"reason": "Minimum required amount is 50000"
}
},
"SBID36": {
"tenure": 36,
"eligibility": {
"status": false,
"reason": "Minimum required amount is 50000"
}
},
"SBID06": {
"tenure": 6,
"eligibility": {
"status": true
}
},
"SBID09": {
"tenure": 9,
"eligibility": {
"status": true
}
}
},
"eligibility": {
"status": true
}
},
"KKBK": {
"tenureOptions": {
"KOTAKD12": {
"tenure": 12,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
},
"KOTAKD03": {
"tenure": 3,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
},
"KOTAKD06": {
"tenure": 6,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
},
"KOTAKD09": {
"tenure": 9,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
}
},
"eligibility": {
"status": false,
"reason": "Customer not eligible for EMI"
}
},
"ICIC": {
"tenureOptions": {
"ICICID12": {
"tenure": 12,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
},
"ICICID03": {
"tenure": 3,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
},
"ICICID06": {
"tenure": 6,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
},
"ICICID09": {
"tenure": 9,
"eligibility": {
"status": false,
"reason": "This mobile number is not eligible. Please change the mobile number."
}
}
},
"eligibility": {
"status": false,
"reason": "Customer not eligible for EMI"
}
}
},
"hasEligible": true
}
}
}
}
}
}
has context menu
Response parameters
JSON Format
{
"requestId": "12345678", // random id - mandatory
"transactionDetails": {
"amount": 12345.12, // mandatory
"...": "..."
},
"customerDetails": {
// optional
"mobile": "9098765432", // optional
"...": "..."
},
"filters": {
// optional - for limiting the data to be fetched
"paymentOptions": {
// optional - if not set, will return all payment options
"emi": {
// optional - only the requested fields will be returned
"dc": "SBIN,KKBK,ICIC", // optional - all means, all options under that category, case insensitive
"...": "..."
},
"...": "..."
},
"...": "..."
},
"useCase": {
// optional
"checkCustomerEligibility": true, // optional - default: false.
"...": "..."
}
}
JSON Fields Description
| JSON Field | Description | Example |
|---|---|---|
| requestId mandatory | String This parameter must contain the request ID. | 12345678 |
| transactionDetails mandatory | JSON This parameter must contain the following fields in a JSON format as in the example:- amount: This field contains the transaction amount - txnid: This fields contains the transaction ID. | { "amount": 12345.12 } |
| useCase mandatory | JSON This field contains list of fields for which you want get information. For the list of fields and its description, refer to the Additional Info for General APIs > useCase JSON Field Description. table. | { "getExtendedPaymentDetails": true } |
| filters optional | JSONThis parameter is used to filter the response of this API based on one or more following in the paymentOptions field:- cc: Filter the credit cards. - dc: Filter the debit cards. - nb: Filter the Net Banking - emi: Filter the EMI options. For list of EMI options, refer to EMI Options for Get Checkout Details API. - upi: Filter the UPI - cash: Filter the wallets | { "paymentOptions": { "emi": { "dc": "SBIN,KKBK,ICIC" } } } |
useCase JSON Field Description
| useCase Field | Description |
|---|---|
| getExtendedPaymentDetails optional | Boolean This flag is posted as true to check EMI eligibility based on mobile number and/or card number depending on the payment method used. Also, checks the eligibility for “Buy Now Pay Later” payment modes.Example: Title, EMI amount breakup, etc details are displayed in the response. For a sample request or response using this field, refer to the Get Extended Payment Details section. |
| getAdditionalCharges optional | Boolean This flag is posted as true to return the additional charges configured for all payment options. For a sample request or response using this field, refer to the Get Additional Charges section. Note: You need to use the getTaxSpecification field if you want to calculate the tax split of additional charges on their end. |
getTaxSpecification optional | Boolean This flag is posted as true to returns the tax specification configured on the backend. Clients can use the result to show the split of additional charges for each payment option. For a sample request or response using this field, refer to the Get Tax Specification section. |
checkDownStatus optional | Boolean This flag is posted as true to return the downtime of the payment options. For a sample request or response using this field, refer to Check Down Status field. |
Request parameters
Additional information for request parameters
| Parameter | Reference |
|---|---|
| key | For more information on how to generate the Key and Salt, refer to any of the following: - Production: Generate Merchant Key and Salt - Test: Generate Test Merchant Key and Salt |
| hash | Hash logic for this API is:sha512(key|command|var1|salt)
sha512 |
| var1 | For JSON fields description, refer to var1 JSON fields description. |
var1 JSON fields description
| JSON Field | Description | Example |
|---|---|---|
| requestId mandatory | String This parameter must contain the request ID. | 12345678 |
| transactionDetails mandatory | JSON This parameter must contain the following fields in a JSON format as in the example:- amount: This field contains the transaction amount - txnid: This fields contains the transaction ID. | { "amount": 12345.12 } |
| useCase mandatory | JSON This field contains list of fields for which you want get information. For the list of fields and its description, refer to the Additional Info for General APIs > useCase JSON Field Description. table. | { "getExtendedPaymentDetails": true } |
| filters optional | JSONThis parameter is used to filter the response of this API based on one or more following in the paymentOptions field:- cc: Filter the credit cards. - dc: Filter the debit cards. - nb: Filter the Net Banking - emi: Filter the EMI options. For list of EMI options, refer to EMI Options for Get Checkout Details API. - upi: Filter the UPI - cash: Filter the wallets | { "paymentOptions": { "emi": { "dc": "SBIN,KKBK,ICIC" } } } |