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.

Payment

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

Events

application/payment/complete/v1

# this event is triggered when payment is completed

application/payment/pending/v1

# this event is triggered when payment is pending

application/payment/failed/v1

# this event is triggered when payment is failed

Payment/payment/complete/v1

this event is triggered when payment is completed

Payload

Properties

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

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Properties

payment_object_list

array of object

Required

Array of Properties

amount_in_paisa

string

Required

amount of payment in paisa

currency

string

Required

currency in which payment need to be done

created_on

string

Required

transaction creation date

modified_on

string

Required

transaction modified date

company_id

string

Required

unique id for the company

payment_gateway

string

Required

name of the payment gateway

current_status

string

Required

current status of the payment

string

Required

unique id of payment

payment_mode_identifier

string

Required

show the sub mode for payment

user_object

object

Required

this contain user details

all_status

array of string

Required

array of all the payment status

application_id

string

Required

sales channel unique id

collected_by

string|null

Required

Payment is collected by whom

refunded_by

string|null

Required

who will be doing the refund

payment_mode

string

Required

show the Mode of payment

aggregator_payment_object

object|null

Additional payment details provided by the payment aggregator, if any.

refund_object

object|null

Details of the refund, if any.

payment_id

string|null

unique id for the transaction

merchant_order_id

string

Required

order id of merchant

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        "payment_object_list",
78        "merchant_order_id"
79      ],
80      "properties": {
81        "payment_object_list": {
82          "type": "array",
83          "items": {
84            "type": "object",
85            "required": [
86              "amount_in_paisa",
87              "currency",
88              "created_on",
89              "modified_on",
90              "company_id",
91              "payment_gateway",
92              "current_status",
93              "id",
94              "payment_mode_identifier",
95              "user_object",
96              "all_status",
97              "application_id",
98              "collected_by",
99              "payment_mode",
100              "refunded_by"
101            ],
102            "properties": {
103              "amount_in_paisa": {
104                "type": "string",
105                "description": "amount of payment in paisa"
106              },
107              "currency": {
108                "type": "string",
109                "description": "currency in which payment need to be done"
110              },
111              "created_on": {
112                "type": "string",
113                "description": "transaction creation date"
114              },
115              "modified_on": {
116                "type": "string",
117                "description": "transaction modified date"
118              },
119              "company_id": {
120                "type": "string",
121                "description": "unique id for the company"
122              },
123              "payment_gateway": {
124                "type": "string",
125                "description": "name of the payment gateway"
126              },
127              "current_status": {
128                "type": "string",
129                "description": "current status of the payment"
130              },
131              "id": {
132                "type": "string",
133                "description": "unique id of payment"
134              },
135              "payment_mode_identifier": {
136                "type": "string",
137                "description": "show the sub mode for payment"
138              },
139              "user_object": {
140                "type": "object",
141                "description": "this contain user details"
142              },
143              "all_status": {
144                "type": "array",
145                "description": "array of all the payment status",
146                "items": {
147                  "type": "string"
148                }
149              },
150              "application_id": {
151                "type": "string",
152                "description": "sales channel unique id"
153              },
154              "collected_by": {
155                "type": [
156                  "string",
157                  "null"
158                ],
159                "description": "Payment is collected by whom"
160              },
161              "refunded_by": {
162                "type": [
163                  "string",
164                  "null"
165                ],
166                "description": "who will be doing the refund"
167              },
168              "payment_mode": {
169                "type": "string",
170                "description": "show the Mode of payment"
171              },
172              "aggregator_payment_object": {
173                "type": [
174                  "object",
175                  "null"
176                ],
177                "description": "Additional payment details provided by the payment aggregator, if any."
178              },
179              "refund_object": {
180                "type": [
181                  "object",
182                  "null"
183                ],
184                "description": "Details of the refund, if any."
185              },
186              "payment_id": {
187                "type": [
188                  "string",
189                  "null"
190                ],
191                "description": "unique id for the transaction"
192              }
193            }
194          }
195        },
196        "merchant_order_id": {
197          "type": "string",
198          "description": "order id of merchant"
199        }
200      }
201    }
202  }
203}

Payload Example

1{
2  "application_id": "620f5e013ef6e213110158bf",
3  "company_id": 1526,
4  "contains": [
5    "merchant_order_id",
6    "payment_object_list"
7  ],
8  "event": {
9    "category": "application",
10    "created_timestamp": 1709117158378,
11    "id": "Q/Vnk1zSEm2xQf8ayByyQdJOIVzx1qmd9I4zxcJVj6M=",
12    "name": "payment",
13    "trace_id": [],
14    "type": "complete",
15    "version": "1"
16  },
17  "payload": {
18    "merchant_order_id": "FY65DF0EE60EE9FEE70A",
19    "payment_object_list": [
20      {
21        "aggregator_payment_object": {},
22        "all_status": [
23          "started",
24          "failed",
25          "pending",
26          "complete"
27        ],
28        "amount_in_paisa": "1100",
29        "application_id": "620f5e013ef6e213110158bf",
30        "collected_by": "fynd",
31        "company_id": "1526",
32        "created_on": "2024-02-28 10:45:58",
33        "currency": "INR",
34        "current_status": "complete",
35        "id": "FY65DF0EE60EE9FEE70A",
36        "modified_on": "2024-02-28 10:45:58",
37        "payment_gateway": "Fynd",
38        "payment_id": "FY65DF0EE60EE9FEE70A",
39        "payment_mode": "COD",
40        "payment_mode_identifier": "11",
41        "refund_object": null,
42        "refunded_by": "fynd",
43        "user_object": {
44          "email": "test@example.com",
45          "id": "61238cb677e64915c444b391",
46          "merchant_user_id": "61238cb677e64915c444b391",
47          "mobile_number": "1111111111"
48        }
49      }
50    ]
51  }
52}

Payment/payment/pending/v1

this event is triggered when payment is pending

Payload

Properties

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

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Payload containing a list of payment objects related to a merchant's order.

Properties

payment_object_list

array of object

Required

List containing details of payment transactions.

Array of Properties

amount_in_paisa

string

Required

Amount of payment in paisa.

currency

string

Required

Currency in which payment needs to be done.

created_on

string

Required

Transaction creation date.

modified_on

string

Required

Transaction modified date.

company_id

string

Required

Unique ID for the company.

payment_gateway

string

Required

Name of the payment gateway.

current_status

string

Required

Current status of the payment.

string

Required

Unique ID of the payment.

payment_mode_identifier

string

Required

Shows the sub-mode for payment.

user_object

object

Required

Contains user details.

all_status

array of string

Required

Array of all the payment statuses.

application_id

string

Required

Sales channel unique ID.

collected_by

string|null

Required

Payment is collected by whom.

refunded_by

string|null

Required

Who will be doing the refund.

payment_mode

string

Required

Shows the mode of payment.

aggregator_payment_object

object|null

Additional payment details provided by the payment aggregator, if any.

refund_object

object|null

Details of the refund, if any.

payment_id

string|null

Unique ID for the transaction.

merchant_order_id

string

Required

Order ID for the merchant.

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        "payment_object_list",
78        "merchant_order_id"
79      ],
80      "properties": {
81        "payment_object_list": {
82          "type": "array",
83          "items": {
84            "type": "object",
85            "required": [
86              "amount_in_paisa",
87              "currency",
88              "created_on",
89              "modified_on",
90              "company_id",
91              "payment_gateway",
92              "current_status",
93              "id",
94              "payment_mode_identifier",
95              "user_object",
96              "all_status",
97              "application_id",
98              "collected_by",
99              "payment_mode",
100              "refunded_by"
101            ],
102            "properties": {
103              "amount_in_paisa": {
104                "type": "string",
105                "description": "Amount of payment in paisa."
106              },
107              "currency": {
108                "type": "string",
109                "description": "Currency in which payment needs to be done."
110              },
111              "created_on": {
112                "type": "string",
113                "description": "Transaction creation date."
114              },
115              "modified_on": {
116                "type": "string",
117                "description": "Transaction modified date."
118              },
119              "company_id": {
120                "type": "string",
121                "description": "Unique ID for the company."
122              },
123              "payment_gateway": {
124                "type": "string",
125                "description": "Name of the payment gateway."
126              },
127              "current_status": {
128                "type": "string",
129                "description": "Current status of the payment."
130              },
131              "id": {
132                "type": "string",
133                "description": "Unique ID of the payment."
134              },
135              "payment_mode_identifier": {
136                "type": "string",
137                "description": "Shows the sub-mode for payment."
138              },
139              "user_object": {
140                "type": "object",
141                "description": "Contains user details."
142              },
143              "all_status": {
144                "type": "array",
145                "description": "Array of all the payment statuses.",
146                "items": {
147                  "type": "string"
148                }
149              },
150              "application_id": {
151                "type": "string",
152                "description": "Sales channel unique ID."
153              },
154              "collected_by": {
155                "type": [
156                  "string",
157                  "null"
158                ],
159                "description": "Payment is collected by whom."
160              },
161              "refunded_by": {
162                "type": [
163                  "string",
164                  "null"
165                ],
166                "description": "Who will be doing the refund."
167              },
168              "payment_mode": {
169                "type": "string",
170                "description": "Shows the mode of payment."
171              },
172              "aggregator_payment_object": {
173                "type": [
174                  "object",
175                  "null"
176                ],
177                "description": "Additional payment details provided by the payment aggregator, if any."
178              },
179              "refund_object": {
180                "type": [
181                  "object",
182                  "null"
183                ],
184                "description": "Details of the refund, if any."
185              },
186              "payment_id": {
187                "type": [
188                  "string",
189                  "null"
190                ],
191                "description": "Unique ID for the transaction."
192              }
193            }
194          },
195          "description": "List containing details of payment transactions."
196        },
197        "merchant_order_id": {
198          "type": "string",
199          "description": "Order ID for the merchant."
200        }
201      },
202      "description": "Payload containing a list of payment objects related to a merchant's order."
203    }
204  }
205}

Payload Example

1{
2  "payload": {
3    "payment_object_list": [
4      {
5        "modified_on": "2024-04-04 11:13:25",
6        "all_status": [
7          "started",
8          "failed",
9          "pending",
10          "complete"
11        ],
12        "company_id": "568",
13        "current_status": "started",
14        "payment_mode": "QR",
15        "payment_mode_identifier": "QR",
16        "payment_gateway": "Razorpay",
17        "id": "FY660E8B400EECA4CC5A",
18        "collected_by": "fynd",
19        "payment_id": "pay_NuWaYR6G8joPZk",
20        "amount_in_paisa": "4400000",
21        "created_on": "2024-04-04 11:13:04",
22        "aggregator_payment_object": {
23          "id": "pay_NuWaYR6G8joPZk",
24          "fee": null,
25          "tax": null,
26          "upi": {
27            "vpa": "test@okicici",
28            "payer_account_type": "bank_account"
29          },
30          "vpa": "test@okicici",
31          "bank": null,
32          "email": "test@example.com",
33          "notes": {
34            "order_id": "order_NuWaCABtaEizkF",
35            "merchant_order_id": "FY660E8B400EECA4CC5A"
36          },
37          "amount": 4400000,
38          "entity": "payment",
39          "method": "upi",
40          "reward": null,
41          "status": "authorized",
42          "wallet": null,
43          "card_id": null,
44          "contact": "1111111111",
45          "captured": false,
46          "currency": "INR",
47          "order_id": null,
48          "created_at": 1712229204,
49          "error_code": null,
50          "error_step": null,
51          "invoice_id": null,
52          "customer_id": "cust_NLh3fYAuwW4jMB",
53          "description": "QRv2 Payment",
54          "error_reason": null,
55          "error_source": null,
56          "acquirer_data": {
57            "rrn": "409560562817"
58          },
59          "international": false,
60          "refund_status": null,
61          "amount_refunded": 0,
62          "error_description": null
63        },
64        "application_id": "5da1aa89e9b4036afd623686",
65        "refund_object": null,
66        "user_object": {
67          "id": "23542890",
68          "email": "test@example.com",
69          "mobile_number": "1111111111",
70          "merchant_user_id": "659a7ab6e0a98803e7153799"
71        },
72        "refunded_by": "fynd",
73        "currency": "INR"
74      },
75      {
76        "modified_on": "2024-04-04 11:13:25",
77        "all_status": [
78          "started",
79          "failed",
80          "pending",
81          "complete"
82        ],
83        "company_id": "568",
84        "current_status": "pending",
85        "payment_mode": "QR",
86        "payment_mode_identifier": "QR",
87        "payment_gateway": "Razorpay",
88        "id": "FY660E8B400EECA4CC5A",
89        "collected_by": "fynd",
90        "payment_id": "pay_NuWaYR6G8joPZk",
91        "amount_in_paisa": "4400000",
92        "created_on": "2024-04-04 11:13:04",
93        "aggregator_payment_object": {
94          "id": "pay_NuWaYR6G8joPZk",
95          "fee": null,
96          "tax": null,
97          "upi": {
98            "vpa": "test@okicici",
99            "payer_account_type": "bank_account"
100          },
101          "vpa": "test@okicici",
102          "bank": null,
103          "email": "test@example.com",
104          "notes": {
105            "order_id": "order_NuWaCABtaEizkF",
106            "merchant_order_id": "FY660E8B400EECA4CC5A"
107          },
108          "amount": 4400000,
109          "entity": "payment",
110          "method": "upi",
111          "reward": null,
112          "status": "authorized",
113          "wallet": null,
114          "card_id": null,
115          "contact": "1111111111",
116          "captured": false,
117          "currency": "INR",
118          "order_id": null,
119          "created_at": 1712229204,
120          "error_code": null,
121          "error_step": null,
122          "invoice_id": null,
123          "customer_id": "cust_NLh3fYAuwW4jMB",
124          "description": "QRv2 Payment",
125          "error_reason": null,
126          "error_source": null,
127          "acquirer_data": {
128            "rrn": "409560562817"
129          },
130          "international": false,
131          "refund_status": null,
132          "amount_refunded": 0,
133          "error_description": null
134        },
135        "application_id": "5da1aa89e9b4036afd623686",
136        "refund_object": null,
137        "user_object": {
138          "id": "23542890",
139          "email": "test@example.com",
140          "mobile_number": "1111111111",
141          "merchant_user_id": "659a7ab6e0a98803e7153799"
142        },
143        "refunded_by": "fynd",
144        "currency": "INR"
145      }
146    ],
147    "merchant_order_id": "FY660E8B400EECA4CC5A"
148  },
149  "contains": [
150    "payment_object_list"
151  ],
152  "event": {
153    "id": "testID",
154    "name": "payment",
155    "type": "pending",
156    "version": "1",
157    "trace_id": [
158      "gringotts.5b3e1ce8-f274-11ee-bfb0-c60d174d5d1b"
159    ],
160    "created_timestamp": 1712229205598,
161    "category": "application"
162  },
163  "company_id": 568,
164  "application_id": "5da1aa89e9b4036afd623686"
165}

Payment/payment/failed/v1

this event is triggered when payment is failed

Payload

Properties

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

Properties

category

string

Required

category of the event. If it is at sales channel level or company level

created_timestamp

integer

Required

event generation timestamp in epoch milliseconds

string

Required

Unique ID for an event. This id can be used to verifiy if event is already processed by receiver

name

string

Required

Name of the event

trace_id

array of string

Required

internal trace_id for Fynd Platform services

type

string

Required

Type/Action of the event. e.g. create/update/delete

version

string

Required

Version of the event.

payload

object

Required

Properties

payment_object_list

array of object

Required

List containing details of payment transactions.

Array of Properties

amount_in_paisa

string

Required

Amount of payment in paisa.

currency

string

Required

Currency in which payment needs to be done.

created_on

string

Required

Transaction creation date.

modified_on

string

Required

Transaction modified date.

company_id

string

Required

Unique ID for the company.

payment_gateway

string

Required

Name of the payment gateway.

current_status

string

Required

Current status of the payment.

string

Required

Unique ID of payment.

payment_mode_identifier

string

Required

Shows the sub-mode for payment.

user_object

object

Required

Contains user details.

all_status

array of string

Required

Array of all the payment statuses.

application_id

string

Required

Sales channel unique ID.

collected_by

string|null

Required

Payment is collected by whom.

refunded_by

string|null

Required

Who will be doing the refund.

payment_mode

string

Required

Shows the mode of payment.

aggregator_payment_object

object|null

Additional payment details provided by the payment aggregator, if any.

refund_object

object|null

Details of the refund, if any.

payment_id

string|null

Unique ID for the transaction.

merchant_order_id

string

Required

Order ID of the merchant.

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        "payment_object_list",
78        "merchant_order_id"
79      ],
80      "properties": {
81        "payment_object_list": {
82          "type": "array",
83          "items": {
84            "type": "object",
85            "required": [
86              "amount_in_paisa",
87              "currency",
88              "created_on",
89              "modified_on",
90              "company_id",
91              "payment_gateway",
92              "current_status",
93              "id",
94              "payment_mode_identifier",
95              "user_object",
96              "all_status",
97              "application_id",
98              "collected_by",
99              "payment_mode",
100              "refunded_by"
101            ],
102            "properties": {
103              "amount_in_paisa": {
104                "type": "string",
105                "description": "Amount of payment in paisa."
106              },
107              "currency": {
108                "type": "string",
109                "description": "Currency in which payment needs to be done."
110              },
111              "created_on": {
112                "type": "string",
113                "description": "Transaction creation date."
114              },
115              "modified_on": {
116                "type": "string",
117                "description": "Transaction modified date."
118              },
119              "company_id": {
120                "type": "string",
121                "description": "Unique ID for the company."
122              },
123              "payment_gateway": {
124                "type": "string",
125                "description": "Name of the payment gateway."
126              },
127              "current_status": {
128                "type": "string",
129                "description": "Current status of the payment."
130              },
131              "id": {
132                "type": "string",
133                "description": "Unique ID of payment."
134              },
135              "payment_mode_identifier": {
136                "type": "string",
137                "description": "Shows the sub-mode for payment."
138              },
139              "user_object": {
140                "type": "object",
141                "description": "Contains user details."
142              },
143              "all_status": {
144                "type": "array",
145                "description": "Array of all the payment statuses.",
146                "items": {
147                  "type": "string"
148                }
149              },
150              "application_id": {
151                "type": "string",
152                "description": "Sales channel unique ID."
153              },
154              "collected_by": {
155                "type": [
156                  "string",
157                  "null"
158                ],
159                "description": "Payment is collected by whom."
160              },
161              "refunded_by": {
162                "type": [
163                  "string",
164                  "null"
165                ],
166                "description": "Who will be doing the refund."
167              },
168              "payment_mode": {
169                "type": "string",
170                "description": "Shows the mode of payment."
171              },
172              "aggregator_payment_object": {
173                "type": [
174                  "object",
175                  "null"
176                ],
177                "description": "Additional payment details provided by the payment aggregator, if any."
178              },
179              "refund_object": {
180                "type": [
181                  "object",
182                  "null"
183                ],
184                "description": "Details of the refund, if any."
185              },
186              "payment_id": {
187                "type": [
188                  "string",
189                  "null"
190                ],
191                "description": "Unique ID for the transaction."
192              }
193            }
194          },
195          "description": "List containing details of payment transactions."
196        },
197        "merchant_order_id": {
198          "type": "string",
199          "description": "Order ID of the merchant."
200        }
201      }
202    }
203  }
204}

Payload Example

1{
2  "event": {
3    "trace_id": [],
4    "name": "payment",
5    "type": "failed",
6    "version": "1",
7    "created_timestamp": 1712150949157,
8    "id": "4da4gOa1sRYXfdZVH/UP49BV1MF0C1ImQ2P0NQIyOZY=",
9    "category": "application"
10  },
11  "company_id": 1103,
12  "application_id": "6331e737cf60c4c03a2cf965",
13  "contains": [
14    "merchant_order_id",
15    "payment_object_list"
16  ],
17  "payload": {
18    "merchant_order_id": "FY660D598B0E603C9107",
19    "payment_object_list": [
20      {
21        "currency": "INR",
22        "amount_in_paisa": "399900",
23        "modified_on": "2024-04-03 13:28:46",
24        "all_status": [
25          "started",
26          "failed",
27          "pending",
28          "complete"
29        ],
30        "id": "FY660D598B0E603C9107",
31        "payment_mode": "UPI",
32        "created_on": "2024-04-03 13:28:43",
33        "refund_object": null,
34        "collected_by": "fynd",
35        "payment_gateway": "Razorpay",
36        "aggregator_payment_object": {
37          "id": "pay_NuAMOIekDBT6rN",
38          "fee": null,
39          "tax": null,
40          "upi": {
41            "vpa": "test-2@ybl"
42          },
43          "vpa": "test-2@ybl",
44          "bank": null,
45          "email": "test@example.com",
46          "notes": [],
47          "amount": 399900,
48          "entity": "payment",
49          "method": "upi",
50          "status": "failed",
51          "wallet": null,
52          "card_id": null,
53          "contact": "1111111111",
54          "captured": false,
55          "currency": "INR",
56          "order_id": "order_NuAMNLfeIjSE2z",
57          "created_at": 1712150924,
58          "error_code": "BAD_REQUEST_ERROR",
59          "error_step": "payment_authentication",
60          "invoice_id": null,
61          "customer_id": "cust_MPthNaAwztxUCQ",
62          "description": null,
63          "error_reason": "payment_cancelled",
64          "error_source": "customer",
65          "acquirer_data": {
66            "rrn": null
67          },
68          "international": false,
69          "refund_status": null,
70          "amount_refunded": 0,
71          "error_description": "You may have cancelled the payment or there was a delay in response from the UPI app."
72        },
73        "application_id": "6331e737cf60c4c03a2cf965",
74        "refunded_by": "fynd",
75        "company_id": "1103",
76        "payment_id": "pay_NuAMOIekDBT6rN",
77        "user_object": {
78          "id": "64d9f1e82e1e95389f116ff3",
79          "email": "test@example.com",
80          "mobile_number": "1111111111",
81          "merchant_user_id": "64d9f1e82e1e95389f116ff3"
82        },
83        "payment_mode_identifier": "test-2@ybl",
84        "current_status": "started"
85      },
86      {
87        "currency": "INR",
88        "amount_in_paisa": "399900",
89        "modified_on": "2024-04-03 13:28:46",
90        "all_status": [
91          "started",
92          "failed",
93          "pending",
94          "complete"
95        ],
96        "id": "FY660D598B0E603C9107",
97        "payment_mode": "UPI",
98        "created_on": "2024-04-03 13:28:43",
99        "refund_object": null,
100        "collected_by": "fynd",
101        "payment_gateway": "Razorpay",
102        "aggregator_payment_object": {
103          "id": "pay_NuAMOIekDBT6rN",
104          "fee": null,
105          "tax": null,
106          "upi": {
107            "vpa": "test-2@ybl"
108          },
109          "vpa": "test-2@ybl",
110          "bank": null,
111          "email": "test@example.com",
112          "notes": [],
113          "amount": 399900,
114          "entity": "payment",
115          "method": "upi",
116          "status": "failed",
117          "wallet": null,
118          "card_id": null,
119          "contact": "1111111111",
120          "captured": false,
121          "currency": "INR",
122          "order_id": "order_NuAMNLfeIjSE2z",
123          "created_at": 1712150924,
124          "error_code": "BAD_REQUEST_ERROR",
125          "error_step": "payment_authentication",
126          "invoice_id": null,
127          "customer_id": "cust_MPthNaAwztxUCQ",
128          "description": null,
129          "error_reason": "payment_cancelled",
130          "error_source": "customer",
131          "acquirer_data": {
132            "rrn": null
133          },
134          "international": false,
135          "refund_status": null,
136          "amount_refunded": 0,
137          "error_description": "You may have cancelled the payment or there was a delay in response from the UPI app."
138        },
139        "application_id": "6331e737cf60c4c03a2cf965",
140        "refunded_by": "fynd",
141        "company_id": "1103",
142        "payment_id": "pay_NuAMOIekDBT6rN",
143        "user_object": {
144          "id": "64d9f1e82e1e95389f116ff3",
145          "email": "test@example.com",
146          "mobile_number": "1111111111",
147          "merchant_user_id": "64d9f1e82e1e95389f116ff3"
148        },
149        "payment_mode_identifier": "test-2@ybl",
150        "current_status": "failed"
151      },
152      {
153        "currency": "INR",
154        "amount_in_paisa": "399900",
155        "modified_on": "2024-04-03 13:28:46",
156        "all_status": [
157          "started",
158          "failed",
159          "pending",
160          "complete"
161        ],
162        "id": "FY660D598B0E603C9107",
163        "payment_mode": "UPI",
164        "created_on": "2024-04-03 13:28:43",
165        "refund_object": null,
166        "collected_by": "fynd",
167        "payment_gateway": "Razorpay",
168        "aggregator_payment_object": {
169          "id": "pay_NuAMOIekDBT6rN",
170          "fee": null,
171          "tax": null,
172          "upi": {
173            "vpa": "test-2@ybl"
174          },
175          "vpa": "test-2@ybl",
176          "bank": null,
177          "email": "test@example.com",
178          "notes": [],
179          "amount": 399900,
180          "entity": "payment",
181          "method": "upi",
182          "status": "failed",
183          "wallet": null,
184          "card_id": null,
185          "contact": "1111111111",
186          "captured": false,
187          "currency": "INR",
188          "order_id": "order_NuAMNLfeIjSE2z",
189          "created_at": 1712150924,
190          "error_code": "BAD_REQUEST_ERROR",
191          "error_step": "payment_authentication",
192          "invoice_id": null,
193          "customer_id": "cust_MPthNaAwztxUCQ",
194          "description": null,
195          "error_reason": "payment_cancelled",
196          "error_source": "customer",
197          "acquirer_data": {
198            "rrn": null
199          },
200          "international": false,
201          "refund_status": null,
202          "amount_refunded": 0,
203          "error_description": "You may have cancelled the payment or there was a delay in response from the UPI app."
204        },
205        "application_id": "6331e737cf60c4c03a2cf965",
206        "refunded_by": "fynd",
207        "company_id": "1103",
208        "payment_id": "pay_NuAMOIekDBT6rN",
209        "user_object": {
210          "id": "64d9f1e82e1e95389f116ff3",
211          "email": "test@example.com",
212          "mobile_number": "1111111111",
213          "merchant_user_id": "64d9f1e82e1e95389f116ff3"
214        },
215        "payment_mode_identifier": "test-2@ybl",
216        "current_status": "failed"
217      }
218    ]
219  }
220}

« order/placed/v1

product/create/v2 »