Application

Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.

Refund

This event will be generated where there is any action done on refund

Events

application/refund/refund_initiated/v1

# this event is triggered when refund is refund_initiated

application/refund/refund_pending/v1

# this event is triggered when refund is refund_pending

application/refund/refund_done/v1

# this event is triggered when refund is refund_done

application/refund/refund_failed/v1

# this event is triggered when refund is refund_failed

Refund/refund/refund_initiated/v1

this event is triggered when refund is refund_initiated

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id"
82      ],
83      "properties": {
84        "amount": {
85          "type": "number",
86          "description": "The Amount to be refunded"
87        },
88        "order_id": {
89          "type": "string",
90          "description": "It is the unique id of Order"
91        },
92        "journey_type": {
93          "type": "string",
94          "description": "Cancallation or return journey for refund."
95        },
96        "payment_status": {
97          "type": "string",
98          "description": "Status of the payment"
99        },
100        "merchant_order_id": {
101          "type": "string",
102          "description": "This is the unique id of order"
103        },
104        "merchant_refund_id": {
105          "type": "string",
106          "description": "This is the unique id of order"
107        },
108        "refund_information": {
109          "type": "array",
110          "items": {
111            "type": "object",
112            "required": [
113              "amount",
114              "mode",
115              "name",
116              "collect_by",
117              "refund_by"
118            ],
119            "properties": {
120              "meta": {
121                "type": "object"
122              },
123              "mode": {
124                "type": "string",
125                "description": "Payment mode via which refund need to be done"
126              },
127              "name": {
128                "type": "string",
129                "description": "The Name of the Mode"
130              },
131              "amount": {
132                "type": "number",
133                "description": "The Amount to be refunded"
134              },
135              "refund_by": {
136                "type": "string",
137                "description": "Whomsoever will refund the money"
138              },
139              "collect_by": {
140                "type": "string",
141                "description": "Whomsoever collected the money"
142              },
143              "payout_details": {
144                "type": "object",
145                "description": "Payout details of refunded mode."
146              },
147              "refund_details": {
148                "type": "object",
149                "properties": {
150                  "ref": {
151                    "type": [
152                      "string",
153                      "null"
154                    ],
155                    "description": "The ref is the Id that we get as a response from payment gateway"
156                  },
157                  "amount": {
158                    "type": "number",
159                    "description": "The Amount to be refunded"
160                  },
161                  "bag_id": {
162                    "type": "string",
163                    "description": "Unique id of the bag"
164                  },
165                  "status": {
166                    "type": "string",
167                    "description": "Show what the current status of the transaction (Pending, Success or failed)"
168                  },
169                  "message": {
170                    "type": [
171                      "string",
172                      "null"
173                    ],
174                    "description": "Refund message from payment gateway."
175                  },
176                  "success": {
177                    "type": "boolean",
178                    "description": "Show whether the transaction is successful or not"
179                  },
180                  "journey_type": {
181                    "type": [
182                      "string",
183                      "null"
184                    ],
185                    "description": "Cancallation or return journey for refund."
186                  },
187                  "payment_status": {
188                    "type": "string",
189                    "description": "Status of the payment"
190                  },
191                  "payout_details": {
192                    "type": "object",
193                    "description": "Payout details of refunded mode."
194                  },
195                  "transaction_id": {
196                    "type": [
197                      "string",
198                      "null"
199                    ],
200                    "description": "Refund transaction id of Fynd platform."
201                  },
202                  "error_traceback": {
203                    "type": [
204                      "string",
205                      "null"
206                    ],
207                    "description": "Complete error traceback of refund failed."
208                  },
209                  "pg_reference_id": {
210                    "type": [
211                      "string",
212                      "null"
213                    ],
214                    "description": "PG refunded reference id."
215                  },
216                  "credit_reinstated": {
217                    "type": [
218                      "string",
219                      "null"
220                    ],
221                    "description": "User credit reactivated after repayment."
222                  },
223                  "unique_request_id": {
224                    "type": [
225                      "string",
226                      "null"
227                    ],
228                    "description": "Unique request id of refund initiation."
229                  },
230                  "merchant_refund_id": {
231                    "type": "string",
232                    "description": "This is the unique id of order"
233                  }
234                }
235              },
236              "payment_gateway": {
237                "type": "string",
238                "description": "Via which payment gateway refund need to be done"
239              },
240              "merchant_order_id": {
241                "type": "string",
242                "description": "This is the unique id of order"
243              },
244              "payment_identifier": {
245                "type": "string",
246                "description": "Payment sub payment mode identifier."
247              },
248              "transaction_timestamp": {
249                "type": [
250                  "string",
251                  "null"
252                ],
253                "description": "Refund transaction unix timestamp."
254              }
255            }
256          }
257        },
258        "forward_shipment_id": {
259          "type": [
260            "string",
261            "null"
262          ],
263          "description": "This is the shipment id"
264        }
265      }
266    }
267  }
268}

Payload Example

1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "order_id",
6    "merchant_refund_id",
7    "merchant_order_id",
8    "payment_status",
9    "journey_type",
10    "forward_shipment_id",
11    "refund_information"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1708969365959,
16    "id": "CZLDHllU18amt/9joTz9+/IfRsr7UfEjG0KDE35xeMk=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_initiated",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": "17089681204691081665",
24    "journey_type": "CANCELLED_CUSTOMER",
25    "merchant_order_id": "2313",
26    "merchant_refund_id": "123123",
27    "order_id": "FY65DCC8B80E8F44EAF1",
28    "payment_status": "refund_initiated",
29    "refund_information": [
30      {
31        "amount": 5995,
32        "collect_by": "fynd",
33        "meta": {
34          "id": "FY65DCC8B80E8F44EAF1",
35          "logo_url": {
36            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",
37            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png"
38          },
39          "mode": "",
40          "payment_id": null
41        },
42        "mode": "PP",
43        "name": "PartnerPay",
44        "refund_by": "fynd"
45      }
46    ]
47  }
48}

Refund/refund/refund_pending/v1

this event is triggered when refund is refund_pending

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id"
82      ],
83      "properties": {
84        "amount": {
85          "type": "number",
86          "description": "The amount to be refunded."
87        },
88        "order_id": {
89          "type": "string",
90          "description": "The unique id of the Order."
91        },
92        "journey_type": {
93          "type": "string",
94          "description": "Cancallation or return journey for refund."
95        },
96        "payment_status": {
97          "type": "string",
98          "description": "Status of the payment."
99        },
100        "merchant_order_id": {
101          "type": "string",
102          "description": "This is the unique id of the order."
103        },
104        "merchant_refund_id": {
105          "type": "string",
106          "description": "This is the unique id of the order."
107        },
108        "refund_information": {
109          "type": "array",
110          "items": {
111            "type": "object",
112            "required": [
113              "amount",
114              "mode",
115              "name",
116              "collect_by",
117              "refund_by"
118            ],
119            "properties": {
120              "meta": {
121                "type": "object"
122              },
123              "mode": {
124                "type": "string",
125                "description": "Payment mode via which the refund needs to be done."
126              },
127              "name": {
128                "type": "string",
129                "description": "The name of the payment mode."
130              },
131              "amount": {
132                "type": "number",
133                "description": "The amount to be refunded."
134              },
135              "refund_by": {
136                "type": "string",
137                "description": "Whomsoever will refund the money."
138              },
139              "collect_by": {
140                "type": "string",
141                "description": "Whomsoever collected the money."
142              },
143              "payout_details": {
144                "type": "object",
145                "description": "Payout details of refunded mode."
146              },
147              "refund_details": {
148                "type": "object",
149                "properties": {
150                  "ref": {
151                    "type": [
152                      "string",
153                      "null"
154                    ],
155                    "description": "The Bank ref is the Id that we get as a response from the payment gateway."
156                  },
157                  "amount": {
158                    "type": "number",
159                    "description": "The amount to be refunded."
160                  },
161                  "bag_id": {
162                    "type": "string",
163                    "description": "Unique id of the bag."
164                  },
165                  "status": {
166                    "type": "string",
167                    "description": "Show what the current status of the transaction (Pending, Success or failed)."
168                  },
169                  "message": {
170                    "type": [
171                      "string",
172                      "null"
173                    ],
174                    "description": "Refund message from payment gateway."
175                  },
176                  "success": {
177                    "type": "boolean",
178                    "description": "Show whether the transaction is successful or not."
179                  },
180                  "journey_type": {
181                    "type": [
182                      "string",
183                      "null"
184                    ],
185                    "description": "Cancallation or return journey for refund."
186                  },
187                  "payment_status": {
188                    "type": "string",
189                    "description": "Status of the payment."
190                  },
191                  "payout_details": {
192                    "type": "object",
193                    "description": "Payout details of refunded mode."
194                  },
195                  "transaction_id": {
196                    "type": [
197                      "string",
198                      "null"
199                    ],
200                    "description": "Refund transaction id of Fynd platform."
201                  },
202                  "error_traceback": {
203                    "type": [
204                      "string",
205                      "null"
206                    ],
207                    "description": "Complete error traceback of refund failed."
208                  },
209                  "pg_reference_id": {
210                    "type": [
211                      "string",
212                      "null"
213                    ],
214                    "description": "PG refunded reference id."
215                  },
216                  "credit_reinstated": {
217                    "type": [
218                      "string",
219                      "null"
220                    ],
221                    "description": "User credit reactivated after repayment."
222                  },
223                  "unique_request_id": {
224                    "type": [
225                      "string",
226                      "null"
227                    ],
228                    "description": "Unique request id of refund initiation."
229                  },
230                  "merchant_refund_id": {
231                    "type": "string",
232                    "description": "This is the unique id of the order."
233                  }
234                }
235              },
236              "payment_gateway": {
237                "type": "string",
238                "description": "Via which payment gateway the refund needs to be done."
239              },
240              "merchant_order_id": {
241                "type": "string",
242                "description": "This is the unique id of the order."
243              },
244              "payment_identifier": {
245                "type": "string",
246                "description": "Payment sub payment mode identifier."
247              },
248              "transaction_timestamp": {
249                "type": [
250                  "string",
251                  "null"
252                ],
253                "description": "Refund transaction unix timestamp."
254              }
255            }
256          }
257        },
258        "forward_shipment_id": {
259          "type": [
260            "string",
261            "null"
262          ],
263          "description": "This is the shipment id."
264        }
265      }
266    }
267  }
268}

Payload Example

1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "merchant_order_id",
6    "forward_shipment_id",
7    "merchant_refund_id",
8    "journey_type",
9    "payment_status",
10    "order_id",
11    "refund_information"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1709545478238,
16    "id": "QNFQau1VoVbPdUotE6X2+iPltm5PdEPTlRm0Rjg25kI=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_pending",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": "17084085671641719614",
24    "journey_type": "RETURN",
25    "merchant_order_id": "FY65D43EF60E2A7E64A7",
26    "merchant_refund_id": "17086147149151382697",
27    "order_id": "FY65D43EF60E2A7E64A7",
28    "payment_status": "refund_pending",
29    "refund_information": [
30      {
31        "amount": 24493,
32        "collect_by": "fynd",
33        "meta": {
34          "id": null,
35          "logo_url": {
36            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png",
37            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png"
38          },
39          "mode": "",
40          "payment_id": "FY65D43EF60E2A7E64A7"
41        },
42        "mode": "COD",
43        "name": "COD",
44        "refund_by": "fynd",
45        "refund_details": {
46          "amount": 24493,
47          "bag_id": "17086147149151382697",
48          "error_traceback": null,
49          "journey_type": "RETURN",
50          "merchant_refund_id": "17086147149151382697",
51          "message": "None",
52          "payment_status": "refund_pending",
53          "payout_details": {
54            "account_holder": "rajendra mohanty",
55            "account_no": "XXXX-XXXX-5326",
56            "address": "dummy data",
57            "bank_name": "ICICI Bank",
58            "beneficiary_id": "5kA7BC/2323==",
59            "branch_name": "PUNE AUNDH NAGRAS ROAD",
60            "comment": "return",
61            "email": "test@example.com",
62            "ifsc_code": "232332",
63            "mobile": "1111111111"
64          },
65          "ref": null,
66          "status": "refund_pending",
67          "success": false,
68          "transaction_id": null,
69          "unique_request_id": null
70        }
71      }
72    ]
73  }
74}

Refund/refund/refund_done/v1

this event is triggered when refund is refund_done

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id",
82        "payment_status"
83      ],
84      "properties": {
85        "amount": {
86          "type": "number",
87          "description": "The Amount to be refunded."
88        },
89        "order_id": {
90          "type": "string",
91          "description": "It is the unique id of Order."
92        },
93        "journey_type": {
94          "type": "string",
95          "description": "Cancallation or return journey for refund."
96        },
97        "payment_status": {
98          "type": "string",
99          "description": "Status of the payment."
100        },
101        "merchant_order_id": {
102          "type": "string",
103          "description": "This is the unique id of merchant order."
104        },
105        "merchant_refund_id": {
106          "type": "string",
107          "description": "This is the unique id of merchant refund."
108        },
109        "refund_information": {
110          "type": "array",
111          "items": {
112            "type": "object",
113            "required": [
114              "amount",
115              "mode",
116              "name",
117              "collect_by",
118              "refund_by"
119            ],
120            "properties": {
121              "meta": {
122                "type": "object"
123              },
124              "mode": {
125                "type": "string",
126                "description": "Payment mode via which refund need to be done."
127              },
128              "name": {
129                "type": "string",
130                "description": "The Name of the Mode."
131              },
132              "amount": {
133                "type": "number",
134                "description": "The Amount to be refunded."
135              },
136              "refund_by": {
137                "type": "string",
138                "description": "Whomsoever will refund the money."
139              },
140              "collect_by": {
141                "type": "string",
142                "description": "Whomsoever collected the money."
143              },
144              "payout_details": {
145                "type": "object",
146                "description": "Payout deatils of refunded mode."
147              },
148              "refund_details": {
149                "type": "object",
150                "required": [
151                  "bag_id",
152                  "status",
153                  "amount",
154                  "merchant_refund_id",
155                  "success",
156                  "payment_status"
157                ],
158                "properties": {
159                  "ref": {
160                    "type": [
161                      "string",
162                      "null"
163                    ],
164                    "description": "Bank reference id of refund."
165                  },
166                  "amount": {
167                    "type": "number",
168                    "description": "Amount refunded."
169                  },
170                  "bag_id": {
171                    "type": "string",
172                    "description": "Unique id of the bag."
173                  },
174                  "status": {
175                    "type": "string",
176                    "description": "Show what the current status of the transaction (Pending, Success or failed)."
177                  },
178                  "message": {
179                    "type": [
180                      "string",
181                      "null"
182                    ],
183                    "description": "Refund message from payment gateway."
184                  },
185                  "success": {
186                    "type": "boolean",
187                    "description": "Refund success boolean flag."
188                  },
189                  "journey_type": {
190                    "type": [
191                      "string",
192                      "null"
193                    ],
194                    "description": "Cancallation or return journey for refund."
195                  },
196                  "payment_status": {
197                    "type": "string",
198                    "description": "Status of the payment."
199                  },
200                  "payout_details": {
201                    "type": "object",
202                    "description": "Payout details of refunded mode."
203                  },
204                  "transaction_id": {
205                    "type": [
206                      "string",
207                      "null"
208                    ],
209                    "description": "Refund transaction id of Fynd platform."
210                  },
211                  "error_traceback": {
212                    "type": [
213                      "string",
214                      "null"
215                    ],
216                    "description": "Complete error traceback of refund failed."
217                  },
218                  "pg_reference_id": {
219                    "type": [
220                      "string",
221                      "null"
222                    ],
223                    "description": "PG refunded reference id."
224                  },
225                  "credit_reinstated": {
226                    "type": [
227                      "string",
228                      "null"
229                    ],
230                    "description": "User credit reactivated after repayment."
231                  },
232                  "unique_request_id": {
233                    "type": [
234                      "string",
235                      "null"
236                    ],
237                    "description": "Unique request id of refund initiation."
238                  },
239                  "merchant_refund_id": {
240                    "type": "string",
241                    "description": "This is the unique id of merchant refund id."
242                  }
243                }
244              },
245              "payment_gateway": {
246                "type": "string",
247                "description": "Via which payment gateway refund need to be done."
248              },
249              "merchant_order_id": {
250                "type": "string",
251                "description": "This is the unique id of order."
252              },
253              "payment_identifier": {
254                "type": "string",
255                "description": "Payment sub payment mode identifier."
256              },
257              "transaction_timestamp": {
258                "type": [
259                  "string",
260                  "null"
261                ],
262                "description": "Refund transaction unix timestamp."
263              }
264            }
265          }
266        },
267        "forward_shipment_id": {
268          "type": [
269            "string",
270            "null"
271          ],
272          "description": "This is the shipment id."
273        }
274      }
275    }
276  }
277}

Payload Example

1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "merchant_order_id",
6    "forward_shipment_id",
7    "refund_information",
8    "order_id",
9    "journey_type",
10    "merchant_refund_id",
11    "payment_status"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1709888766983,
16    "id": "pE+z6QTnSfB+5kwRF1bM/BTUVu8oNTUNfM23+yKw318=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_done",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": "17094000377291693395",
24    "journey_type": "RETURN",
25    "merchant_order_id": "FY65E35FE50E388CAD4D",
26    "merchant_refund_id": "17098100629891965689",
27    "order_id": "FY65E35FE50E388CAD4D",
28    "payment_status": "refund_done",
29    "refund_information": [
30      {
31        "amount": 6999,
32        "collect_by": "fynd",
33        "meta": {
34          "id": "FY65E35FE50E388CAD4D",
35          "logo_url": {
36            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",
37            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png"
38          },
39          "mode": "",
40          "payment_id": null
41        },
42        "mode": "PP",
43        "name": "PartnerPay",
44        "refund_by": "fynd",
45        "refund_details": {
46          "amount": 6999,
47          "bag_id": "17098100629891965689",
48          "error_traceback": null,
49          "journey_type": "RETURN",
50          "merchant_refund_id": "17098100629891965689",
51          "message": "data fetched",
52          "payment_status": "refund_done",
53          "payout_details": {
54            "acquirer_data": {
55              "rrn": null
56            },
57            "amount": 699900,
58            "batch_id": "",
59            "created_at": 1709888766,
60            "currency": "INR",
61            "entity": "refund",
62            "id": "rfnd_NjnzpKdBhN4YDY",
63            "notes": {
64              "merchant_refund_id": "17098100629891965689"
65            },
66            "payment_id": "pay_NhZE3htyDN2K4z",
67            "receipt": "17098100629891965689",
68            "speed_processed": "normal",
69            "speed_requested": "normal",
70            "status": "processed"
71          },
72          "pg_reference_id": "rfnd_NjnzpKdBhN4YDY",
73          "ref": "rfnd_NjnzpKdBhN4YDY",
74          "status": "refund_done",
75          "success": true,
76          "transaction_id": null,
77          "unique_request_id": "rfnd_NjnzpKdBhN4YDY"
78        }
79      }
80    ]
81  }
82}

Refund/refund/refund_failed/v1

this event is triggered when refund is refund_failed

Payload

Hide

application_id

array|string

Required

sales channel ID for which this event is triggered

company_id

integer

Required

company ID for which this event is triggered

contains

array of string

Required

This array will have all the keys present at root level of 'payload' object

event

object

Required

Show

payload

object

Required

Show

Payload Schema JSON

1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "properties": {
11    "application_id": {
12      "type": [
13        "array",
14        "string"
15      ],
16      "description": "sales channel ID for which this event is triggered"
17    },
18    "company_id": {
19      "type": "integer",
20      "description": "company ID for which this event is triggered"
21    },
22    "contains": {
23      "type": "array",
24      "description": "This array will have all the keys present at root level of 'payload' object",
25      "items": {
26        "type": "string"
27      }
28    },
29    "event": {
30      "type": "object",
31      "required": [
32        "category",
33        "created_timestamp",
34        "id",
35        "name",
36        "trace_id",
37        "type",
38        "version"
39      ],
40      "properties": {
41        "category": {
42          "type": "string",
43          "description": "category of the event. If it is at sales channel level or company level"
44        },
45        "created_timestamp": {
46          "type": "integer",
47          "description": "event generation timestamp in epoch milliseconds"
48        },
49        "id": {
50          "type": "string",
51          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52        },
53        "name": {
54          "type": "string",
55          "description": "Name of the event"
56        },
57        "trace_id": {
58          "type": "array",
59          "description": "internal trace_id for Fynd Platform services",
60          "items": {
61            "type": "string"
62          }
63        },
64        "type": {
65          "type": "string",
66          "description": "Type/Action of the event. e.g. create/update/delete"
67        },
68        "version": {
69          "type": "string",
70          "description": "Version of the event."
71        }
72      }
73    },
74    "payload": {
75      "type": "object",
76      "required": [
77        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id"
82      ],
83      "properties": {
84        "amount": {
85          "type": "number",
86          "description": "The Amount to be refunded"
87        },
88        "order_id": {
89          "type": "string",
90          "description": "It is the unique id of Order"
91        },
92        "journey_type": {
93          "type": "string",
94          "description": "Cancallation or return journey for refund. "
95        },
96        "payment_status": {
97          "type": "string",
98          "description": "Status of the payment"
99        },
100        "merchant_order_id": {
101          "type": "string",
102          "description": "This is the unique id of order"
103        },
104        "merchant_refund_id": {
105          "type": "string",
106          "description": "This is the unique id of order"
107        },
108        "refund_information": {
109          "type": "array",
110          "items": {
111            "type": "object",
112            "required": [
113              "amount",
114              "mode",
115              "name",
116              "collect_by",
117              "refund_by"
118            ],
119            "properties": {
120              "meta": {
121                "type": "object",
122                "description": "Open meta dictionary of refund information."
123              },
124              "mode": {
125                "type": "string",
126                "description": "Payment mode via which refund need to be done"
127              },
128              "name": {
129                "type": "string",
130                "description": "The Name of the Mode"
131              },
132              "amount": {
133                "type": "number",
134                "description": "The Amount to be refunded"
135              },
136              "refund_by": {
137                "type": "string",
138                "description": "Whomsoever will refund the money"
139              },
140              "collect_by": {
141                "type": "string",
142                "description": "Whomsoever collected the money"
143              },
144              "payout_details": {
145                "type": "object",
146                "description": "Payout details of refunded mode."
147              },
148              "refund_details": {
149                "type": "object",
150                "properties": {
151                  "ref": {
152                    "type": [
153                      "string",
154                      "null"
155                    ],
156                    "description": "The ref is the Id that we get as a response from the payment gateway"
157                  },
158                  "amount": {
159                    "type": "number",
160                    "description": "The Amount to be refunded"
161                  },
162                  "bag_id": {
163                    "type": "string",
164                    "description": "Unique id of the bag"
165                  },
166                  "status": {
167                    "type": "string",
168                    "description": "Show what the current status of the transaction (Pending, Success or failed)"
169                  },
170                  "message": {
171                    "type": [
172                      "string",
173                      "null"
174                    ],
175                    "description": "Refund message from payment gateway."
176                  },
177                  "success": {
178                    "type": "boolean",
179                    "description": "Show whether the transaction is successful or not"
180                  },
181                  "journey_type": {
182                    "type": [
183                      "string",
184                      "null"
185                    ],
186                    "description": "Cancallation or return journey for refund."
187                  },
188                  "payment_status": {
189                    "type": "string",
190                    "description": "Status of the payment"
191                  },
192                  "payout_details": {
193                    "type": "object",
194                    "description": "Payout details of refunded mode."
195                  },
196                  "transaction_id": {
197                    "type": [
198                      "string",
199                      "null"
200                    ],
201                    "description": "Refund transaction id of Fynd platform."
202                  },
203                  "error_traceback": {
204                    "type": [
205                      "string",
206                      "null"
207                    ],
208                    "description": "Complete error traceback of refund failed."
209                  },
210                  "pg_reference_id": {
211                    "type": [
212                      "string",
213                      "null"
214                    ],
215                    "description": "PG refunded reference id."
216                  },
217                  "credit_reinstated": {
218                    "type": [
219                      "string",
220                      "null"
221                    ],
222                    "description": "User credit reactivated after repayment."
223                  },
224                  "unique_request_id": {
225                    "type": [
226                      "string",
227                      "null"
228                    ],
229                    "description": "Unique request id of refund initiation."
230                  },
231                  "merchant_refund_id": {
232                    "type": "string",
233                    "description": "This is the unique id of order"
234                  }
235                }
236              },
237              "payment_gateway": {
238                "type": "string",
239                "description": "Via which payment gateway refund need to be done"
240              },
241              "merchant_order_id": {
242                "type": "string",
243                "description": "This is the unique id of order"
244              },
245              "payment_identifier": {
246                "type": "string",
247                "description": "Payment sub payment mode identifier."
248              },
249              "transaction_timestamp": {
250                "type": [
251                  "string",
252                  "null"
253                ],
254                "description": "Refund transaction unix timestamp."
255              }
256            }
257          }
258        },
259        "forward_shipment_id": {
260          "type": [
261            "string",
262            "null"
263          ],
264          "description": "Unique id of the bag"
265        }
266      }
267    }
268  }
269}

Payload Example

1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "refund_information",
6    "payment_status",
7    "forward_shipment_id",
8    "merchant_refund_id",
9    "merchant_order_id",
10    "order_id",
11    "journey_type"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1708966106532,
16    "id": "f5unLVyao4mq4bFI4vp9kl16YkzujEk4cSlJwtZDU9I=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_failed",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": null,
24    "journey_type": "RETURN",
25    "merchant_order_id": "1233123",
26    "merchant_refund_id": "123",
27    "order_id": "FY65BD3A0D0E8EB05F77",
28    "payment_status": "refund_failed",
29    "refund_information": [
30      {
31        "amount": 14999,
32        "collect_by": "fynd",
33        "meta": {
34          "logo_url": {
35            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png",
36            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png"
37          },
38          "mode": ""
39        },
40        "mode": "COD",
41        "name": "COD",
42        "refund_by": "fynd"
43      }
44    ]
45  }
46}

« promotion_usage/update/v1

return_config/update/v1 »