--- page_source: https://docs.juspay.io/offers/docs/basic-offers-module/refunds-on-offered-transaction page_title: Refunds on Offered Transaction --- # Refunds for Offers Juspay provides two flows with which refund against a offered transaction can be initiated as below, 1. **Full Refund** : * Total Order amount will be refunded to the customer. * Counters/Velocity value are reset i.e counters will be decrement by 1 2. **Partial Refund** : * Only the initiated Order amount will be refunded to the customer. * Counters/Velocity value will not be reset > **Note** > * Refund has to be initiated on the `effective_amount` > * Cashback amount will get reduced from the refund amount in case of Refund for cashback offer benefit type ## Sample Code Snippets: ### Order Status Responses: #### Request Code Snippet: ```request { "payer_app_name": "net.one97.paytm", "bank_pg": null, "payment_method": "UPI", "customer_phone": "FILTERED", "payment_gateway_response": { "txn_id": "Merchant-M2DDS3ZYU37KTA-1", "rrn": "418632", "auth_id_code": null, "resp_message": "Txn Success", "epg_txn_id": "2024070421041704710", "resp_code": "01", "created": "2024-07-04T05:56:15Z" }, "udf8": "", "txn_id": "Merchant-M2DDS3ZYU37KTA-1", "order_id": "M2DDS3ZYU37KTA", "gateway_reference_id": null, "maximum_eligible_refund_amount": 0, "udf9": "", "txn_detail": { "txn_id": "Merchant-M2DDS3ZYU37KTA-1", "order_id": "M2DDS3ZYU37KTA", "error_code": "", "txn_flow_type": "INTENT", "status": "CHARGED", "express_checkout": false, "gateway_id": 19, "error_message": "", "tax_amount": null, "currency": "INR", "txn_amount": 346, "created": "2024-07-04T05:56:00Z", "gateway": "PAYTM_V2", "surcharge_amount": null, "txn_uuid": "moz6qXNviJWWTjz", "net_amount": 346, "redirect": true, "metadata": { "payment_channel": "ANDROID" } }, "customer_id": "86983454", "amount": 346, "refunds": [ { "error_code": null, "amount": 346, "status": "SUCCESS", "ref": null, "initiated_by": "API", "error_message": "", "refund_source": "PAYTM_V2", "id": null, "created": "2024-07-04T05:59:54Z", "refund_type": "STANDARD", "unique_request_id": "M2DDUWRDOY375LQ", "sent_to_gateway": true, "arn": "4558760" } ], "udf4": "", "status": "CHARGED", "udf5": "", "udf6": "", "status_id": 21, "offers": [ { "offer_code": "PAYTMUPI010724", "offer_id": "56f38ff9-4c9e-4ed1-9b75-78ef5a543b95", "status": "REFUNDED", "benefits": [ { "amount": 0, "type": "CASHBACK", "calculation_info": { "calculation_rule": "ABSOLUTE", "value": 0 } } ], "metadata": { "minimum_order_amount":"200.00" } } ], "udf7": "", "product_id": "", "refunded": true, "udf10": "", "gateway_id": 19, "udf1": "enable", "udf2": "headlessAndroid", "udf3": "", "date_created": "2024-07-04T05:55:59Z", "id": "ordeh_95ce06e893942229ec6", "merchant_id": "Merchant", "return_url": "https://www.Merchant.com/mcheckout/orderStatus", "effective_amount": 346, "currency": "INR", "auth_type": "", "customer_email": "1111111", "upi": { "txn_flow_type": "INTENT", "payer_app": "net.one97.paytm" }, "payment_method_type": "UPI", "txn_uuid": "moz6qXNviJWWTjz", "payment_links": { "mobile": "https://api.juspay.in/orders/ordeh_95ce06e893942229ec6/payment-page", "web": "https://api.juspay.in/orders/ordeh_95ce06e893942229ec6/payment-page", "iframe": "https://api.juspay.in/orders/ordeh_95ce06e893942229ec6/payment-page" }, "amount_refunded": 346, "bank_error_code": "", "bank_error_message": "" } ``` #### Partial Refund Code Snippet: ```partial refund { "payer_app_name": "net.one97.paytm", "payment_method": "UPI", "customer_phone": "FILTERED", "payment_gateway_response": { "network_error_message": null, "txn_id": "Merchant-M2CSGYCCWQTPWCQ-1", "rrn": "455195823788", "auth_id_code": "", "resp_message": "Txn Success", "epg_txn_id": "20240703210420078589", "resp_code": "01", "created": "2024-07-03T10:09:56Z", "network_error_code": null }, "udf8": "", "txn_id": "Merchant-M2CSGYCCWQTPWCQ-1", "order_id": "M2CSGYCCWQTPWCQ", "gateway_reference_id": null, "maximum_eligible_refund_amount": 0, "udf9": "", "txn_detail": { "txn_id": "Merchant-M2CSGYCCWQTPWCQ-1", "order_id": "M2CSGYCCWQTPWCQ", "error_code": null, "txn_flow_type": "INTENT", "status": "CHARGED", "express_checkout": false, "gateway_id": 19, "error_message": "", "offer_deduction_amount": 0, "tax_amount": null, "currency": "INR", "txn_amount_breakup": "FILTERED", "txn_amount": 242, "created": "2024-07-03T10:09:45Z", "gateway": "PAYTM_V2", "surcharge_amount": null, "txn_uuid": "mozxj5z4mBhahxnnLjs", "net_amount": 242, "redirect": true, "metadata": { "payment_channel": "ANDROID" } }, "customer_id": "7630321126", "amount": 242, "refunds": [ { "reversal_type": "FILTERED", "amount": 121, "status": "SUCCESS", "ref": "202407032242850482257938589", "initiated_by": "API", "error_message": "Refund Successfull", "refund_source": "PAYTM_V2", "id": "M2CSKOHV3D7457Q", "created": "2024-07-03T10:17:28Z", "refund_type": "STANDARD", "unique_request_id": "M2CSKOHV3D7457Q", "sent_to_gateway": true, "arn": "4551240" } ], "udf4": "", "status": "CHARGED", "udf5": "", "udf6": "", "status_id": 21, "offers": [ { "offer_code": "FILTERED", "offer_id": "56f38ff9-4c9e-78ef5a543b95", "status": "PARTIALLY_REFUNDED", "benefits": [ { "amount": 0, "type": "CASHBACK", "calculation_info": { "calculation_rule": "FILTERED", "value": 0 } } ], "metadata": { "minimum_order_amount":"200.00" } } ], "udf7": "", "resp_message": null, "product_id": "", "refunded": false, "udf10": "", "gateway_id": 19, "udf1": "enable", "udf2": "headlessAndroid", "udf3": "", "date_created": "2024-07-03T10:09:39Z", "id": "ordeh_555259ddc6e74325", "merchant_id": "Merchant", "return_url": "https://www.Merchant.com/mcheckout/orderStatus", "effective_amount": "FILTERED", "currency": "INR", "auth_type": "", "customer_email": "1111111", "resp_code": null, "upi": { "txn_flow_type": "INTENT", "payer_app": "net.one97.paytm" }, "payment_method_type": "UPI", "txn_uuid": "mozxj5z4mBhahxnnLjs", "resp_category": null, "payment_links": { "mobile": "https://payments.juspay.in/payment-page/order/ordeh_555259ddc6e74325", "web": "https://payments.juspay.in/payment-page/order/ordeh_555259ddc6e74325", "iframe": "https://payments.juspay.in/payment-page/order/ordeh_555259ddc6e74325" }, "amount_refunded": 121, "bank_error_code": "", "bank_error_message": "" } ``` ### Webhooks: #### Full Refund: ```plaintext { "event_name": "ORDER_REFUNDED", "content": { "order": { "payer_app_name": "net.one97.paytm", "bank_pg": null, "payment_method": "UPI", "customer_phone": "FILTERED", "payment_gateway_response": { "txn_id": "Merchant-M2DDS3ZYU37KTA-1", "rrn": "418632", "auth_id_code": null, "resp_message": "Txn Success", "epg_txn_id": "2024070421041704710", "resp_code": "01", "created": "2024-07-04T05:56:15Z" }, "udf8": "", "txn_id": "Merchant-M2DDS3ZYU37KTA-1", "order_id": "M2DDS3ZYU37KTA", "gateway_reference_id": null, "maximum_eligible_refund_amount": 0, "udf9": "", "txn_detail": { "txn_id": "Merchant-M2DDS3ZYU37KTA-1", "order_id": "M2DDS3ZYU37KTA", "error_code": "", "txn_flow_type": "INTENT", "status": "CHARGED", "express_checkout": false, "gateway_id": 19, "error_message": "", "tax_amount": null, "currency": "INR", "txn_amount": 346, "created": "2024-07-04T05:56:00Z", "gateway": "PAYTM_V2", "surcharge_amount": null, "txn_uuid": "moz6qXNviJWWTjz", "net_amount": 346, "redirect": true, "metadata": { "payment_channel": "ANDROID" } }, "customer_id": "FILTERED", "amount": 346, "refunds": [ { "reversal_type": "FILTERED", "amount": 346, "status": "SUCCESS", "ref": "20240704220372246404710", "initiated_by": "API", "error_message": "Refund Successfull", "refund_source": "PAYTM_V2", "id": "M2DDUWRDOY375LQ", "created": "2024-07-04T05:59:54Z", "refund_type": "STANDARD", "unique_request_id": "M2DDUWRDOY375LQ", "sent_to_gateway": true, "arn": "4558760" } ], "udf4": "", "status": "CHARGED", "udf5": "", "udf6": "", "status_id": 21, "offers": [ { "offer_code": "PAYTMUPI010724", "offer_id": "56f38ff9-4c9e-4ed1-9b75-78ef5a543b95", "status": "REFUNDED", "benefits": "FILTERED", "metadata": {"minimum_order_amount":"200.00"} } ], "udf7": "", "product_id": "", "refunded": true, "udf10": "", "gateway_id": 19, "udf1": "enable", "udf2": "headlessAndroid", "udf3": "", "date_created": "2024-07-04T05:55:59Z", "id": "ordeh_95ce06e893942229ec6", "merchant_id": "Merchant", "return_url": "https://www.Merchant.com/mcheckout/orderStatus", "effective_amount": 346, "currency": "INR", "auth_type": "", "customer_email": "FILTERED", "upi": { "txn_flow_type": "INTENT", "payer_app": "FILTERED" }, "payment_method_type": "UPI", "txn_uuid": "moz6qXNviJWWTjz", "payment_links": { "mobile": "https://api.juspay.in/orders/ordeh_95ce06e893942229ec6/payment-page", "web": "https://api.juspay.in/orders/ordeh_95ce06e893942229ec6/payment-page", "iframe": "https://api.juspay.in/orders/ordeh_95ce06e893942229ec6/payment-page" }, "amount_refunded": 346, "bank_error_code": "", "metadata": { "payment_page_client_id": "Merchant", "payment_links": { "mobile": "https://payments.juspay.in/payment-page/order/ordeh_95ce06e893942229ec6", "web": "https://payments.juspay.in/payment-page/order/ordeh_95ce06e893942229ec6", "iframe": "https://payments.juspay.in/payment-page/order/ordeh_95ce06e893942229ec6" } }, "bank_error_message": "" } }, "date_created": "2024-07-04T06:25:11Z", "id": "evt_V2_c1173f62068e" } ``` #### Partial Refund: ```plaintext { "event_name": "ORDER_REFUNDED", "content": { "order": { "payer_app_name": "net.one97.paytm", "bank_pg": null, "payment_method": "UPI", "customer_phone": "FILTERED", "payment_gateway_response": { "txn_id": "Merchant-M2CSGYCCWQTPWCQ-1", "rrn": "455195823788", "auth_id_code": null, "resp_message": "Txn Success", "epg_txn_id": "20240703210420078589", "resp_code": "01", "created": "2024-07-03T10:09:56Z" }, "udf8": "", "txn_id": "Merchant-M2CSGYCCWQTPWCQ-1", "order_id": "M2CSGYCCWQTPWCQ", "gateway_reference_id": null, "maximum_eligible_refund_amount": 0, "udf9": "", "txn_detail": { "txn_id": "Merchant-M2CSGYCCWQTPWCQ-1", "order_id": "M2CSGYCCWQTPWCQ", "error_code": "", "txn_flow_type": "INTENT", "status": "CHARGED", "express_checkout": false, "gateway_id": 19, "error_message": "", "tax_amount": null, "currency": "INR", "txn_amount": 242, "created": "2024-07-03T10:09:45Z", "gateway": "PAYTM_V2", "surcharge_amount": null, "txn_uuid": "mozxj5z4mBhahxnnLjs", "net_amount": 242, "redirect": true, "metadata": { "payment_channel": "ANDROID" } }, "customer_id": "FILTERED", "amount": 242, "refunds": [ { "reversal_type": "FILTERED", "amount": 121, "status": "SUCCESS", "ref": "202407032242850482257938589", "initiated_by": "API", "error_message": "Refund Successfull", "refund_source": "PAYTM_V2", "id": "M2CSKOHV3D7457Q", "created": "2024-07-03T10:17:28Z", "refund_type": "STANDARD", "unique_request_id": "M2CSKOHV3D7457Q", "sent_to_gateway": true, "arn": "4551240" } ], "udf4": "", "status": "CHARGED", "udf5": "", "udf6": "", "status_id": 21, "offers": [ { "offer_code": "PAYTMUPI010724", "offer_id": "56f38ff9-4c9e-78ef5a543b95", "status": "PARTIALLY_REFUNDED", "benefits": "FILTERED", "metadata": { "minimum_order_amount":"200.00" } } ], "udf7": "", "product_id": "", "refunded": false, "udf10": "", "gateway_id": 19, "udf1": "enable", "udf2": "headlessAndroid", "udf3": "", "date_created": "2024-07-03T10:09:39Z", "id": "ordeh_555259ddc6e74325", "merchant_id": "Merchant", "return_url": "https://www.Merchant.com/mcheckout/orderStatus", "effective_amount": 242, "currency": "INR", "auth_type": "", "customer_email": "FILTERED", "upi": { "txn_flow_type": "INTENT", "payer_app": "FILTERED" }, "payment_method_type": "UPI", "txn_uuid": "mozxj5z4mBhahxnnLjs", "payment_links": { "mobile": "https://api.juspay.in/orders/ordeh_555259ddc6e74325/payment-page", "web": "https://api.juspay.in/orders/ordeh_555259ddc6e74325/payment-page", "iframe": "https://api.juspay.in/orders/ordeh_555259ddc6e74325/payment-page" }, "amount_refunded": 121, "bank_error_code": "", "metadata": { "payment_page_client_id": "Merchant", "payment_links": { "mobile": "https://payments.juspay.in/payment-page/order/ordeh_555259ddc6e74325", "web": "https://payments.juspay.in/payment-page/order/ordeh_555259ddc6e74325", "iframe": "https://payments.juspay.in/payment-page/order/ordeh_555259ddc6e74325" } }, "bank_error_message": "" } }, "date_created": "2024-07-03T10:47:04Z", "id": "evt_V2_9a0d5d06428f8e15f20" } ```