Scheme Validation v2

Scheme Validation Integration

Introduction

1. Overview

It checks the validity of selected offer on a card number for both issuer level and OEM level validation.

2. Implementation Details

UAT - https://uat.pinepg.in/api/v2/scheme/validation

PRODUCTION - https://pinepg.in/api/v2/scheme/validation

CURL:

{
    "merchant_data": {
        "merchant_id": 119815,
        "merchant_access_code": "0b8453fc-d7a2-4770-91cf-e2e01e6f65dd"
    },
    "payment_data": {
        "amount_in_paisa": 1000000
    },
    "card_data": {
        "card_number": "4012001037141112"
    },
    "emi_data": {
        "offer_scheme": {
            "product_details": [
                {
                    "schemes": [
                        {
                            "scheme_id": 50144,
                            "program_type": 112,
                            "is_scheme_valid": true
                        }
                    ],
                    "product_code": "58327",
                    "product_amount": 1000000,
                    "subvention_cashback_discount": 20000,
                    "product_discount": 0,
                    "subvention_cashback_discount_percentage": 20000,
                    "product_discount_percentage": 0,
                    "subvention_type": 2,
                    "bank_interest_rate_percentage": 140000,
                    "bank_interest_rate": 13770
                }
            ],
            "emi_scheme": {
                "scheme_id": 50143,
                "program_type": 105,
                "is_scheme_valid": true
            }
        },
        "tenure_id": "3",
        "tenure_in_month": "3",
        "monthly_installment": 200590,
        "bank_interest_rate": 140000,
        "interest_pay_to_bank": 13770,
        "total_offerred_discount_cashback_amount": 20000,
        "loan_amount": 588000,
        "auth_amount": 980000,
        "deferred_amount": "392000",
        "deferred_percentage": "400000"
    }
}

Request:

Body Params:

Parameter Name	Type	Description
merchant_data	object	It contains information about merchant.
payment_data	object	It contains information about payment data.
card_data	Object	It contains information about Card data.
emi_data	Object	It contains information about emi data

merchant_data:

Parameter Name	Type	Description	Mandatory(M)/Optional
merchant_id	int	Merchant id provided by pine labs.	M
merchant_access_code	string	Merchant access code provided by pine labs.	M

payment_data:

Parameter Name	Type	Description	Mandatory(M)/Optional
amount_in_paisa	long	Total sum of products amount present in cart.	M

card_data:

Parameter Name	Type	Description
card_number	String	Card number
card_expiry_year	String	Card expiry year having format YYYY
card_expiry_month	String	Card expiry month having format MM
card_holder_name	String	Card holder name

tokenize_card_data:

Parameter Name	Type	Description
token	String	Card token received from token requestor
expiration_month	String	Card expiry month having format MM
expiration_year	String	Card expiry year having format YYYY
last4Digit	String	Last 4 Digit of Card

emi_data:

Parameter Name	Type	Description
offer_scheme	Object	It contains information about offer applicable on each product.
tenure_id	Int	Tenure Id specified at pine labs end.
tenure_in_month	String	Tenure name specified at pine labs end.
monthly_installment	Long	Emi amount in paise.
bank_interest_rate	Long	Interest rate for which bank emi is calculated. Its value is percentage multiplied by 10000.
interest_pay_to_bank	Long	Interest pay to bank in paise.
total_offerred_discount_cashback_amount	Long	Total sum of discount applicable on cart. It is in paise.
loan_amount	Long	Amount in paise on which loan will be booked.
auth_amount	Long	Bank authorization amount in paise.

offer_scheme:

Parameter Name	Type	Description
product_details	Array of objects	It contains information about product.
emi_scheme	Object	It contains information about bank EMI scheme.

product_details:

Parameter Name	Type	Description
product_code	String	Product code.
product_amount	Long	Product amount in paise.
subvention_cashback_discount	Long	Subvention discount cashback amount in paise. Only applicable when subvention is present.
product_discount	Long	Product discount amount in paise. Only applicable if product discount is present.
subvention_cashback_discount_percentage	Long	Subvention discount cashback percentage. Its value is percentage multiplied by 10000.
product_discount_percentage	Long	Product discount cashback percentage. Its value is percentage multiplied by 10000.
subvention_type	Int	It tells offer type. 1-No cost EMI 2-Low cost EMI 3-Standard EMI.
additional_cashback	String	Additional cashback text.
bank_interest_rate	Long	Amount in paise.
bank_interest_rate_percentage	Long	Percentage multiplied by 10000.
schemes	Array of objects	It contains list of program applicable on product.

emi_scheme:

Parameter Name	Type	Description
scheme_id	Long	It tells scheme id applicable on product.
program_type	Int	It tells scheme of which type. 105-Bank EMI 106-Brand EMI 108-Product Discount 112-Subvention discount.
is_scheme_valid	Bool	Is scheme is valid.

schemes:

Parameter Name	Type	Description
scheme_id	Long	It tells scheme id applicable on product.
program_type	Int	It tells scheme of which type. 105-Bank EMI 106-Brand EMI 108-Product Discount 112-Subvention discount.
is_scheme_valid	Bool	Is scheme is valid.

Sample Request for All Credit cards:

{
    "merchant_data": {
        "merchant_id": 3473,
        "merchant_access_code": "57e39383-b053-4db9-a708-26d8971886e7"
    },
    "payment_data": {
        "amount_in_paisa": 1100000
    },
    "card_data": {
        "card_number": "4012001037141112"
    },
    "emi_data": {
        "offer_scheme": {
            "product_details": [
                {
                    "schemes": [
                        {
                            "scheme_id": 1682,
                            "program_type": 112,
                            "is_scheme_valid": true
                        }
                    ],
                    "product_code": "SM-G975FCWG",
                    "product_amount": 550000,
                    "subvention_cashback_discount": 11705,
                    "product_discount": 0,
                    "subvention_cashback_discount_percentage": 21500,
                    "product_discount_percentage": 0,
                    "subvention_type": 1
                },
                {
                    "schemes": [],
                    "product_code": "40",
                    "product_amount": 550000,
                    "subvention_cashback_discount": 0,
                    "product_discount": 0,
                    "subvention_cashback_discount_percentage": 0,
                    "product_discount_percentage": 0
                }
            ],
            "emi_scheme": {
                "scheme_id": 1683,
                "program_type": 105,
                "is_scheme_valid": true
            }
        },
        "tenure_id": "3",
        "tenure_in_month": "3",
        "monthly_installment": 370652,
        "bank_interest_rate": 130000,
        "interest_pay_to_bank": 23661,
        "total_offerred_discount_cashback_amount": 11705,
        "loan_amount": 1088295,
        "auth_amount": 1088295
    }
}

Response:

params:

Parameter Name	Type	Description
response_code	int	It notifies the result of api processing. Value 1 denotes success.
response_message	string	It denotes the message corresponding to above code

Sample Response:

Success response

{
    "response_code": 1,
    "response_message": "SUCCESS"
}

Failure response

{
    "response_code": -289,
    "response_message": "SCHEME VALIDATION FAILED"
}