--- page_source: https://juspay.io/in/docs/payment-method-integrations/hypercheckout/simpl-sod/new-step-48015 page_title: New Step --- # **Simpl SoD (Simpl on Delivery) Onboarding and API Specification Documentation** ## Pre-Requisites ### Step 1.1 New Gateway Creation ## **Adding a new gateway account for Simpl SoD from the Juspay Dashboard** Merchants can follow the steps below to configure Simpl and add the Simpl SoD payment method from the Juspay Merchant Dashboard. * Log in to the Juspay Merchant Dashboard Portal. * Go to EC operations and select the PG Control Centre option. * Click on Other Gateways under the list of commonly configured gateways and search for SIMPL. * Select Live credentials to configure production credentials or Test credentials to configure UAT credentials, and click on Configure on Live/Test button. * Fill all the required fields, select the SIMPL_SoD payment method, and complete the configuration. * While completing the above step, make sure to enable the Is Pre Authorisation Enabled? option under Advanced Features in the Payment Method Configurations section to use the Simpl SoD feature. **NOTE:** To configure Simpl using the Legacy Dashboard Version, follow these steps: * Log in to the Juspay Merchant Dashboard Portal. Navigate to the PG Control Center section (_EC Operations >>_ PG Control Centre). * Select SIMPL from the Create Gateway drop-down menu. * Fill in the required fields, turn on the test mode toggle if the filled-in details are test credentials, and then proceed to select the SIMPL_SoD payment method. While completing the above step, make sure to turn on Is Pre Authorisation Enabled? to use the Simpl SoD feature. ### Step 1.2 Updating Existing Gateway ## **Updating existing gateway account to add Simpl SoD from the Juspay Dashboard** Merchants can follow the steps below to add the Simpl SoD payment method for already configured gateway accounts from the Juspay Merchant Dashboard. * Log in to the Juspay Merchant Dashboard Portal. Go to EC operations and select the PG Control Centre option. * Select an already-configured PG account under the Configured Payment Gateways section for which the Simpl SoD feature needs to be enabled. * Click on the Edit Gateway Configuration button and select the SIMPL_SoD payment method in the Payment Method Configurations section. Enable Is Pre Authorisation Enabled? option under Advanced Features in the Payment Method Configurations section. **NOTE:** To perform above operations using Legacy Dashboard Version, follow these steps: * Log in to the Juspay Merchant Dashboard Portal. Navigate to the PG Control Center section (EC Operations >> PG Control Centre). * Select an already-configured PG account under the Gateways Management section for which the Simpl SoD feature needs to be enabled. * Click on the Update button, turn on Is Pre Authorisation Enabled? and select the SIMPL_SoD payment method in the Payment Method Configurations section. ### Step 1.3 Studio Changes ## **Enabling Pay on Delivery Section on UI** Enable Cash On Delivery on Juspay Studio. ![Image](https://dth95m2xtyv8v.cloudfront.net/tesseract/assets/payment-method-integrations/SOD%20DOc%20Images.png) ## Sample Requests and Responses ## _**Session API**_ **Request CURL:** #### Shell Code Snippet: ```shell curl --location --request POST 'https://sandbox.juspay.in/session' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic 82Q19002******==' \ --data-raw '{ "order_id": "ref_939", "amount": "100.0", "customer_id": "cth_pKL9ayw75febC1Dd", "customer_email": "test@mail.com", "customer_phone": "9986028298", "payment_page_client_id": "sugar", "action": "paymentPage", "return_url": "http://www.juspay.in", "description": "Complete your payment", "first_name": "John", "last_name": "wick", "product_id": "test123", "quantity": "1", "merchant_id": "merchant_success", "currency": "INR", "metadata.SIMPL:gateway_reference_id": "simpl_sod", "simpl_additional_info": { "shipping_address": { "line1": "54999", "line2": "300 Randolph Parkways Apt. 902", "city": "Shauntown", "state": "Drives", "country": "French Guiana", "pincode": "400611" }, "merchant_params": { "email": "shshh@gamil.com", "first_txn_date": "2019-07-17", "user_loyalty_level": "Gold", "user_blacklist_flag": "true", "request_ori_page": "precheckout", "seller_identifier": "123", "seller_vintage": "4", "seller_category": "PRIME", "additional_order_id": "12345", "first_name": "Simpl", "last_name": "Simpl", "aggregator_flow_ori": "PP" } } }' ``` **Sample Response:** As the payment link in the response is opened, Simpl on Delivery will be shown to eligible users in the Pay on Delivery Section #### Shell Code Snippet: ```shell { "status": "NEW", "id": "ordeh_54cca71a932840399502d3b2666c729d", "order_id": "ref_253", "payment_links": { "web": "https://sandbox.juspay.in/orders/ordeh_54cca71a932840399502d3b2666c729d/payment-page", "expiry": null }, "sdk_payload": { "requestId": "2b81edee38e34f8e82a581fcedf6eef4", "service": "in.juspay.hyperpay", "payload": { "clientId": "geddit", "amount": "100.0", "metadata.SIMPL:gatewayReferenceId": "simpl_sod", "merchantId": "merchant_success", "clientAuthToken": "tkn_defae86c77db4ce880cb2be9ffdb82b2", "clientAuthTokenExpiry": "2023-08-21T12:11:59Z", "environment": "sandbox", "lastName": "wick", "quantity": "1", "action": "paymentPage", "customerId": "cth_jJeDKnpQDuL8XWk6", "returnUrl": "http://www.juspay.in", "simplAdditionalInfo": { "shipping_address": { "line2": "300 Randolph Parkways Apt. 902", "state": "Drives", "pincode": "400611", "country": "French Guiana", "city": "Shauntown", "line1": "54999" }, "merchant_params": { "first_txn_date": "2019-07-17", "email": "shshh@gamil.com", "additional_order_id": "12345", "first_name": "Simpl", "user_loyalty_level": "Gold", "seller_identifier": "123", "seller_vintage": "4", "user_blacklist_flag": "true", "request_ori_page": "precheckout", "aggregator_flow_ori": "PP", "last_name": "Simpl", "seller_category": "PRIME" } }, "currency": "INR", "firstName": "John", "customerPhone": "9986028298", "customerEmail": "test@mail.com", "orderId": "ref_253", "productId": "test123", "description": "Complete your payment" } } } ``` ## _**Signature Payload**_ #### Shell Code Snippet: ```shell "payload": { "action": "paymentPage", "clientId": "picasso", "language": "english", "merchantId": "picasso", "environment": "sandbox", "customerId": "9986028298", "orderId": "DW-FRROJjp0Ij", "amount": "1.00", "endUrls": [ "https://sandbox.juspay.in/end" ], "customerEmail": "test007@gmail.com", "merchantKeyId": "8321", "orderDetails": "{\"simplAdditionalInfo\":{\"merchant_params\":{\"email\":\"shshh@gamil.com\",\"user_loyalty_level\":\"Gold\",\"user_blacklist_flag\":\"true\",\"coupon_applied\":\"Coupon Code: MluY-76478694\",\"request_ori_page\":\"precheckout\",\"seller_identifier\":\"123\",\"seller_vintage\":\"4\",\"seller_category\":\"PRIME\",\"additional_order_id\":\"12345\",\"first_name\":\"Simpl\",\"last_name\":\"Simpl\",\"aggregator_flow_ori\":\"seamless\"},\"shippining_address\":{\"line1\":\"54999\",\"line2\":\"300 Randolph Parkways Apt. 902\",\"city\":\"Shauntown\",\"state\":\"Drives\",\"country\":\"French Guiana\",\"pincode\":\"400611\"}},\"order_id\":\"DW-FRROJjp0Ij\",\"first_name\":\"Test\",\"last_name\":\"Customer\",\"customer_phone\":\"9986028298\",\"customer_email\":\"test@gmail.com\",\"merchant_id\":\"picasso\",\"amount\":\"1.00\",\"customer_id\":\"9986028298\",\"timestamp\":\"1692712941234\",\"return_url\":\"https://sandbox.juspay.in/end\",\"currency\":\"INR\",\"mandate.start_date\":\"1692712941234\",\"mandate.end_date\":\"2134731745451\"}", "signature": "sZ2p6OjVQPBj1BHK7+jieXgmprckkwS26iRZj6bbadYSSURBcmKiqjX3xaph6rii8en8aODl8cnvd9vUho9rRon4hFa3ESXTj5VXvDNMQXDl5icdglBtJhh2ZuSqi9rW4sr5sIijDcH5hpvPoODpdb7n4YGCD+h8LzbWSHTPyC8jLBKs0p8Y1PuH5X1W9eNK2t4bEKNm31fgmqrMgnj/r7lATdrqiOBs12hKv1Tmoe1rpI+TmJ41B0F/RuFcKcDvYbuXOJVSCW413QkDHthgvNUWj0m02g+02NukZXrHD1TdEpGS7tDvxlt0FS7o20lbeks9v8f4x3hgcyeHWx5T/Q==", "processStartedTime": 1692712941955 } ``` ![Image](https://dth95m2xtyv8v.cloudfront.net/tesseract/assets/payment-method-integrations/SOD.png) The payment instrument will be rendered for eligible users and txns will be initiated when user clicks on proceed to pay. ## **Post creation of transaction** ## _**Capture Call**_ Merchants can capture the amount after delivery using the Capture API. **Request CURL:** #### Shell Code Snippet: ```shell curl --location 'https://sandbox.juspay.in/v2/txns/mozgYDycsEacBY7QXVy/capture' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Basic N0JBRDA4OUExxxxxxYxxxxxEyNDlCNjY3QTVCMUQzM0Q6' \ --data-urlencode 'amount=3.00' \ --data-urlencode 'idempotence_key=moz1702884759' ``` **Sample Response:** #### Shell Code Snippet: ```shell { "order_id": "SimplINR1685618499", "udf3": "", "status": "CHARGED", "amount": 1, "auth_type": "", "wallet": { "txn_flow_type": "REDIRECT_DEBIT" }, "refunded": false, "udf8": "", "udf5": "", "payment_method": "SIMPL_SOD", "gateway_id": 41, "udf2": "", "payment_method_type": "WALLET", "txn_uuid": "mozt4zuA4fQkQBrCPKb", "udf4": "", "customer_id": "cth_juaYpRsaw87yu9wG", "udf10": "", "payment_links": { "iframe": "https://sandbox.juspay.in/r/7fF7wR", "web": "https://sandbox.juspay.in/r/i6UP5D", "mobile": "https://sandbox.juspay.in/r/tU1IDU" }, "effective_amount": 1, "udf1": "", "payment_gateway_response": { "auth_id_code": "NA", "created": "2023-06-01T11:21:56Z", "rrn": "", "epg_txn_id": "3aa5f0bb-abf0-4c4a-8634-33fa8c08c6c0", "txn_id": "azhar_test-SimplINR1685618499-1", "resp_message": "CLAIMED", "resp_code": "CLAIMED" }, "product_id": "product_243", "amount_refunded": 0, "customer_email": "nagendra.p@juspay.in", "currency": "INR", "customer_phone": "9608754682", "bank_error_message": "", "id": "ordeh_d02232792ab44ff093a123f07516b08f", "txn_id": "azhar_test-SimplINR1685618499-1", "merchant_id": "azhar_test", "resp_message": null, "maximum_eligible_refund_amount": 1, "udf7": "", "date_created": "2023-06-01T11:21:40Z", "bank_error_code": "", "offers": [], "udf9": "", "return_url": "https://e3b6c0d9b8c8c44fc1ab2b6ee8ff1183.m.pipedream.net", "status_id": 21, "resp_code": null, "udf6": "" } ``` Things to keep in mind: 1. Please replace the txnUuid in the url with the txnUuid received in the txn created webhook or the order status API. 2. Metadata is an optional field. ## _**Void Call**_ Merchants can call the void api to cancel or void the authorized transaction. **Request CURL:** #### Shell Code Snippet: ```shell curl --location 'https://sandbox.juspay.in/v2/txns/mozqT7iHim5bifH4gAt/void' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Basic N0JBRDA4OUExRjYwNxxxxxxxxxxCNjY3QTVCMUQzM0Q6' \ --data-urlencode 'amount=3' \ --data-urlencode 'idempotence_key=moz1702885023' ``` **Sample Response:** #### Shell Code Snippet: ```shell { "order_id": "SimplINR1685624308", "udf3": "", "status": "VOIDED", "amount": 1, "auth_type": "", "wallet": { "txn_flow_type": "REDIRECT_DEBIT" }, "refunded": false, "udf8": "", "udf5": "", "payment_method": "SIMPL_SOD", "gateway_id": 41, "udf2": "", "payment_method_type": "WALLET", "txn_uuid": "moz89qoR6hLx2ufcJXd", "udf4": "", "customer_id": "cth_trEULzwjYJnKXeu4", "udf10": "", "payment_links": { "iframe": "https://sandbox.juspay.in/r/jeNJNH", "web": "https://sandbox.juspay.in/r/laHk3m", "mobile": "https://sandbox.juspay.in/r/sImQ3F" }, "effective_amount": 1, "udf1": "", "payment_gateway_response": { "auth_id_code": "NA", "created": "2023-06-01T12:58:37Z", "rrn": "", "epg_txn_id": "bedf0d40-635b-40f5-8f6b-5e16881ba1f4", "txn_id": "azhar_test-SimplINR1685624308-1", "resp_message": "CANCELLED", "resp_code": "CANCELLED" }, "product_id": "product_429", "amount_refunded": 0, "customer_email": "nagendra.p@juspay.in", "currency": "INR", "customer_phone": "9608754682", "bank_error_message": "CANCELLED", "id": "ordeh_0a033cfa1cdd4cd78f749df1aad9b71b", "txn_id": "azhar_test-SimplINR1685624308-1", "merchant_id": "azhar_test", "resp_message": null, "udf7": "", "date_created": "2023-06-01T12:58:28Z", "bank_error_code": "CANCELLED", "offers": [], "udf9": "", "return_url": "https://e3b6c0d9b8c8c44fc1ab2b6ee8ff1183.m.pipedream.net", "status_id": 31, "resp_code": null, "udf6": "" } ``` ## _**Refund Call**_ If the merchant wants to do a refund, they can use our refund API call. **Request CURL:** #### Shell Code Snippet: ```shell curl --location 'https://sandbox.juspay.in/refunds' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'version: 2019-03-19' \ --header 'Authorization: Basic N0JBRDA4xxxxxxxxxxxxxxxxxxlCNjY3QTVCMUQzM0Q6' \ --data-urlencode 'unique_request_id=refund_7800a8ed-eb1f-42a4-b6e0-f3798737cf03' \ --data-urlencode 'amount=1' \ --data-urlencode 'order_id=o1704709095' \ --data-urlencode 'metadata.merchant_capture_id=moz1704449291' ``` **Sample Response:** #### Shell Code Snippet: ```shell { "order_id": "simpl1685541467", "udf3": "", "status": "CHARGED", "amount": 1, "auth_type": "", "wallet": { "txn_flow_type": "DIRECT_DEBIT" }, "refunded": true, "udf8": "", "udf5": "", "payment_method": "SIMPL_SOD", "gateway_id": 41, "refunds": [ { "status": "SUCCESS", "amount": 1, "sent_to_gateway": true, "unique_request_id": "URI1685691582", "error_code": null, "arn": "a10cbac0-a80a-4b6e-9e8e-00934a50ab72", "created": "2023-06-02T07:39:42Z", "pg_processed_at": "2023-06-02T07:39:42Z", "initiated_by": "API", "refund_source": "SIMPL", "error_message": "NA", "expected_refund_credit_time": "2023-06-13T08:00:00Z", "id": null, "bank_processed_at": "2023-06-02T07:39:42Z", "refund_type": "STANDARD", "ref": "a10cbac0-a80a-4b6e-9e8e-00934a50ab72" } ], "udf2": "", "payment_method_type": "WALLET", "txn_uuid": "mozbfb3HjjPsBDwkkbB", "udf4": "", "customer_id": "cth_mATjeMUn38ghrJcv", "udf10": "", "bank_pg": null, "payment_links": { "iframe": "https://sandbox.juspay.in/merchant/ipay/ordeh_0cda18bd101a4a4e94bff0f6b8f36da6", "web": "https://sandbox.juspay.in/merchant/pay/ordeh_0cda18bd101a4a4e94bff0f6b8f36da6", "mobile": "https://sandbox.juspay.in/merchant/pay/ordeh_0cda18bd101a4a4e94bff0f6b8f36da6?mobile=true" }, "effective_amount": 1, "udf1": "", "payment_gateway_response": { "auth_id_code": "NA", "created": "2023-05-31T13:58:11Z", "rrn": "", "epg_txn_id": "dddc9a7f-2d1c-4c3a-bd52-b981323f873b", "txn_id": "azhar_test-simpl1685541467-1", "resp_message": "CLAIMED", "resp_code": "CLAIMED" }, "product_id": "ProductId_68", "amount_refunded": 1, "customer_email": "jus.j@juspay.in", "currency": "INR", "customer_phone": "9608754682", "bank_error_message": "", "id": "ordeh_0cda18bd101a4a4e94bff0f6b8f36da6", "txn_id": "azhar_test-simpl1685541467-1", "merchant_id": "azhar_test", "maximum_eligible_refund_amount": 0, "udf7": "", "date_created": "2023-05-31T13:57:47Z", "bank_error_code": "", "offers": [], "udf9": "", "return_url": "www.google.com", "status_id": 21, "udf6": "" } ``` ## _**Order Status Call**_ **Request CURL:** #### Shell Code Snippet: ```shell curl --location --request GET 'https://api.juspay.in/orders/JP1636474794' \ --header 'version: 2021-10-25' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Basic OTc5Mzcx*****czRTlGOg==' ``` **Sample Response:** #### Shell Code Snippet: ```shell { "customer_email": "malav.shah@juspay.in", "customer_phone": "7076607677", "customer_id": "7076607677", "status_id": 23, "status": "PENDING_VBV", "id": "ordeh_9251b30c102b43c9bf841280bf319d3b", "merchant_id": "merchant_success", "amount": 1, "currency": "INR", "order_id": "test_1692937996", "date_created": "2023-08-25T04:33:16Z", "return_url": "https://google.com", "product_id": "Shocks", "payment_links": { "iframe": "https://sandbox.juspay.in/orders/ordeh_9251b30c102b43c9bf841280bf319d3b/payment-page", "web": "https://sandbox.juspay.in/orders/ordeh_9251b30c102b43c9bf841280bf319d3b/payment-page", "mobile": "https://sandbox.juspay.in/orders/ordeh_9251b30c102b43c9bf841280bf319d3b/payment-page" }, "udf1": "", "udf2": "", "udf3": "", "udf4": "", "udf5": "", "udf6": "", "udf7": "", "udf8": "", "udf9": "", "udf10": "", "txn_id": "ms-test_1692937996-1", "payment_method_type": "CARD", "auth_type": "THREE_DS", "card": { "expiry_year": "2029", "card_reference": "", "saved_to_locker": false, "expiry_month": "04", "name_on_card": "Rahul Agarwal", "card_issuer": "ICICI Bank", "last_four_digits": "7823", "using_saved_card": false, "card_fingerprint": "6tp38u4hforepdacermdhlcfkd", "card_isin": "516640", "card_type": "DEBIT", "card_brand": "MASTERCARD", "using_token": false, "tokens": [], "card_issuer_country": "INDIA", "juspay_bank_code": "JP_ICICI", "extended_card_type": "MASTERCARD", "payment_account_reference": "" }, "payment_method": "MASTERCARD", "refunded": false, "amount_refunded": 0, "effective_amount": 1, "resp_code": null, "resp_message": null, "bank_error_code": "", "bank_error_message": "", "txn_uuid": "mozbQSyAuwW3kWjvNgH", "txn_detail": { "txn_id": "ms-test_1692937996-1", "order_id": "test_1692937996", "status": "PENDING_VBV", "error_code": null, "net_amount": 1, "surcharge_amount": 0, "tax_amount": 0, "txn_amount": 1, "offer_deduction_amount": null, "gateway_id": 23, "currency": "INR", "express_checkout": false, "redirect": true, "txn_uuid": "mozbQSyAuwW3kWjvNgH", "gateway": "RAZORPAY", "error_message": "", "created": "2023-08-25T04:33:23Z", "txn_flow_type": "CARD_TRANSACTION" }, "gateway_id": 23, "metadata": { "payment_links": { "iframe": "https://sandbox.juspay.in/orders/ordeh_9251b30c102b43c9bf841280bf319d3b/payment-page", "web": "https://sandbox.juspay.in/orders/ordeh_9251b30c102b43c9bf841280bf319d3b/payment-page", "mobile": "https://sandbox.juspay.in/orders/ordeh_9251b30c102b43c9bf841280bf319d3b/payment-page" }, "payment_page_client_id": "defaultclient" }, "gateway_reference_id": null, "offers": [] } ``` # **Annexure** ### _**TXN_CREATED Webhook**_ #### Shell Code Snippet: ```shell { "id": "evt_V2_077795cc51ac412bb3e09988ceb4bfcc", "event_name": "TXN_CREATED", "date_created": "2023-08-25T04:37:52Z", "content": { "order": { "offers": [], "txn_id": "zupee-JP1692938263875DLQ9T-1", "udf7": "168861988908046", "payment_method": "UPI", "txn_uuid": "mozmmVPAEJcdbsPKahR", "udf5": "", "status_id": 23, "amount_refunded": 0, "udf9": "414fd9bdc2c864788915a802e8b16f", "gateway_reference_id": null, "status": "PENDING_VBV", "bank_error_message": "", "id": "ordeh_78ddd368681d4d07a92a0decee47b373", "auth_type": "", "udf3": "", "udf6": "", "udf10": "", "effective_amount": 20, "product_id": "", "bank_pg": null, "order_id": "JP1692938263875DLQ9T", "return_url": "https://api.ludosupreme.com/v1.0/payment/juspayWebhook", "udf1": "1", "currency": "INR", "udf4": "", "customer_id": "FILTERED", "date_created": "2023-08-25T04:37:43Z", "gateway_id": 23, "upi": "FILTERED", "payment_links": { "web": "https://api.juspay.in/merchant/pay/ordeh_78ddd368681d4d07a92a0decee47b373", "iframe": "https://api.juspay.in/merchant/ipay/ordeh_78ddd368681d4d07a92a0decee47b373", "mobile": "https://api.juspay.in/merchant/pay/ordeh_78ddd368681d4d07a92a0decee47b373?mobile=true" }, "txn_detail": { "express_checkout": false, "txn_id": "zupee-JP1692938263875DLQ9T-1", "txn_amount": 20, "error_message": "", "txn_uuid": "mozmmVPAEJcdbsPKahR", "created": "2023-08-25T04:37:52Z", "metadata": { "payment_channel": "ANDROID", "microapp": "ec" }, "gateway": "RAZORPAY", "status": "PENDING_VBV", "net_amount": 20, "order_id": "JP1692938263875DLQ9T", "currency": "INR", "error_code": null, "gateway_id": 23, "surcharge_amount": null, "txn_flow_type": "FILTERED", "tax_amount": null, "redirect": true }, "bank_error_code": "", "udf8": "", "payment_method_type": "UPI", "customer_phone": "FILTERED", "merchant_id": "zupee", "customer_email": "FILTERED", "udf2": "", "amount": 20, "payer_app_name": "FILTERED", "refunded": false } } } ```