cashfree-pg 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish-dev-channel.yml +26 -0
- package/.github/workflows/publish.yml +25 -0
- package/.openapi-generator/FILES +13 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/CODE_OF_CONDUCT.md +128 -0
- package/LICENSE.md +201 -0
- package/README.md +1 -0
- package/SECURITY.md +11 -0
- package/api.ts +9319 -0
- package/base.ts +72 -0
- package/common.ts +170 -0
- package/configuration.ts +110 -0
- package/dist/api.d.ts +4967 -0
- package/dist/api.js +4585 -0
- package/dist/base.d.ts +54 -0
- package/dist/base.js +59 -0
- package/dist/common.d.ts +64 -0
- package/dist/common.js +179 -0
- package/dist/configuration.d.ts +91 -0
- package/dist/configuration.js +51 -0
- package/dist/esm/api.d.ts +4967 -0
- package/dist/esm/api.js +4581 -0
- package/dist/esm/base.d.ts +54 -0
- package/dist/esm/base.js +54 -0
- package/dist/esm/common.d.ts +64 -0
- package/dist/esm/common.js +167 -0
- package/dist/esm/configuration.d.ts +91 -0
- package/dist/esm/configuration.js +47 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +34 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +19 -0
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,4967 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Cashfree Payment Gateway APIs
|
|
3
|
+
* Cashfree\'s Payment Gateway APIs provide developers with a streamlined pathway to integrate advanced payment processing capabilities into their applications, platforms and websites.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-09-01
|
|
6
|
+
* Contact: developers@cashfree.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { CFEnvironment } from './configuration';
|
|
14
|
+
/**
|
|
15
|
+
* Error at cashfree\'s server
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ApiError
|
|
18
|
+
*/
|
|
19
|
+
export interface ApiError {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof ApiError
|
|
24
|
+
*/
|
|
25
|
+
'message'?: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof ApiError
|
|
30
|
+
*/
|
|
31
|
+
'code'?: string;
|
|
32
|
+
/**
|
|
33
|
+
* api_error
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ApiError
|
|
36
|
+
*/
|
|
37
|
+
'type'?: ApiErrorTypeEnum;
|
|
38
|
+
}
|
|
39
|
+
export declare const ApiErrorTypeEnum: {
|
|
40
|
+
readonly API_ERROR: "api_error";
|
|
41
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
42
|
+
};
|
|
43
|
+
export type ApiErrorTypeEnum = typeof ApiErrorTypeEnum[keyof typeof ApiErrorTypeEnum];
|
|
44
|
+
/**
|
|
45
|
+
* Error when resource requested is not found
|
|
46
|
+
* @export
|
|
47
|
+
* @interface ApiError404
|
|
48
|
+
*/
|
|
49
|
+
export interface ApiError404 {
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof ApiError404
|
|
54
|
+
*/
|
|
55
|
+
'message'?: string;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof ApiError404
|
|
60
|
+
*/
|
|
61
|
+
'code'?: string;
|
|
62
|
+
/**
|
|
63
|
+
* invalid_request_error
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof ApiError404
|
|
66
|
+
*/
|
|
67
|
+
'type'?: ApiError404TypeEnum;
|
|
68
|
+
}
|
|
69
|
+
export declare const ApiError404TypeEnum: {
|
|
70
|
+
readonly INVALID_REQUEST_ERROR: "invalid_request_error";
|
|
71
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
72
|
+
};
|
|
73
|
+
export type ApiError404TypeEnum = typeof ApiError404TypeEnum[keyof typeof ApiError404TypeEnum];
|
|
74
|
+
/**
|
|
75
|
+
* duplicate request
|
|
76
|
+
* @export
|
|
77
|
+
* @interface ApiError409
|
|
78
|
+
*/
|
|
79
|
+
export interface ApiError409 {
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @type {string}
|
|
83
|
+
* @memberof ApiError409
|
|
84
|
+
*/
|
|
85
|
+
'message'?: string;
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @type {string}
|
|
89
|
+
* @memberof ApiError409
|
|
90
|
+
*/
|
|
91
|
+
'code'?: string;
|
|
92
|
+
/**
|
|
93
|
+
* invalid_request_error
|
|
94
|
+
* @type {string}
|
|
95
|
+
* @memberof ApiError409
|
|
96
|
+
*/
|
|
97
|
+
'type'?: ApiError409TypeEnum;
|
|
98
|
+
}
|
|
99
|
+
export declare const ApiError409TypeEnum: {
|
|
100
|
+
readonly INVALID_REQUEST_ERROR: "invalid_request_error";
|
|
101
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
102
|
+
};
|
|
103
|
+
export type ApiError409TypeEnum = typeof ApiError409TypeEnum[keyof typeof ApiError409TypeEnum];
|
|
104
|
+
/**
|
|
105
|
+
* Error when there is error at partner bank
|
|
106
|
+
* @export
|
|
107
|
+
* @interface ApiError502
|
|
108
|
+
*/
|
|
109
|
+
export interface ApiError502 {
|
|
110
|
+
/**
|
|
111
|
+
*
|
|
112
|
+
* @type {string}
|
|
113
|
+
* @memberof ApiError502
|
|
114
|
+
*/
|
|
115
|
+
'message'?: string;
|
|
116
|
+
/**
|
|
117
|
+
* `bank_processing_failure` will be returned here to denote failure at bank.
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof ApiError502
|
|
120
|
+
*/
|
|
121
|
+
'code'?: string;
|
|
122
|
+
/**
|
|
123
|
+
* api_error
|
|
124
|
+
* @type {string}
|
|
125
|
+
* @memberof ApiError502
|
|
126
|
+
*/
|
|
127
|
+
'type'?: ApiError502TypeEnum;
|
|
128
|
+
}
|
|
129
|
+
export declare const ApiError502TypeEnum: {
|
|
130
|
+
readonly API_ERROR: "api_error";
|
|
131
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
132
|
+
};
|
|
133
|
+
export type ApiError502TypeEnum = typeof ApiError502TypeEnum[keyof typeof ApiError502TypeEnum];
|
|
134
|
+
/**
|
|
135
|
+
* App payment method
|
|
136
|
+
* @export
|
|
137
|
+
* @interface App
|
|
138
|
+
*/
|
|
139
|
+
export interface App {
|
|
140
|
+
/**
|
|
141
|
+
* Specify the channel through which the payment must be processed.
|
|
142
|
+
* @type {string}
|
|
143
|
+
* @memberof App
|
|
144
|
+
*/
|
|
145
|
+
'channel': string;
|
|
146
|
+
/**
|
|
147
|
+
* Specify the provider through which the payment must be processed.
|
|
148
|
+
* @type {string}
|
|
149
|
+
* @memberof App
|
|
150
|
+
*/
|
|
151
|
+
'provider': AppProviderEnum;
|
|
152
|
+
/**
|
|
153
|
+
* Customer phone number associated with a wallet for payment.
|
|
154
|
+
* @type {string}
|
|
155
|
+
* @memberof App
|
|
156
|
+
*/
|
|
157
|
+
'phone': string;
|
|
158
|
+
}
|
|
159
|
+
export declare const AppProviderEnum: {
|
|
160
|
+
readonly GPAY: "gpay";
|
|
161
|
+
readonly PHONEPE: "phonepe";
|
|
162
|
+
readonly OLA: "ola";
|
|
163
|
+
readonly PAYTM: "paytm";
|
|
164
|
+
readonly AMAZON: "amazon";
|
|
165
|
+
readonly AIRTEL: "airtel";
|
|
166
|
+
readonly FREECHARGE: "freecharge";
|
|
167
|
+
readonly MOBIKWIK: "mobikwik";
|
|
168
|
+
readonly JIO: "jio";
|
|
169
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
170
|
+
};
|
|
171
|
+
export type AppProviderEnum = typeof AppProviderEnum[keyof typeof AppProviderEnum];
|
|
172
|
+
/**
|
|
173
|
+
* App payment method
|
|
174
|
+
* @export
|
|
175
|
+
* @interface AppPaymentMethod
|
|
176
|
+
*/
|
|
177
|
+
export interface AppPaymentMethod {
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @type {App}
|
|
181
|
+
* @memberof AppPaymentMethod
|
|
182
|
+
*/
|
|
183
|
+
'app': App;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Error if api keys are wrong
|
|
187
|
+
* @export
|
|
188
|
+
* @interface AuthenticationError
|
|
189
|
+
*/
|
|
190
|
+
export interface AuthenticationError {
|
|
191
|
+
/**
|
|
192
|
+
*
|
|
193
|
+
* @type {string}
|
|
194
|
+
* @memberof AuthenticationError
|
|
195
|
+
*/
|
|
196
|
+
'message'?: string;
|
|
197
|
+
/**
|
|
198
|
+
*
|
|
199
|
+
* @type {string}
|
|
200
|
+
* @memberof AuthenticationError
|
|
201
|
+
*/
|
|
202
|
+
'code'?: string;
|
|
203
|
+
/**
|
|
204
|
+
* authentication_error
|
|
205
|
+
* @type {string}
|
|
206
|
+
* @memberof AuthenticationError
|
|
207
|
+
*/
|
|
208
|
+
'type'?: string;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* If preauth enabled for account you will get this body
|
|
212
|
+
* @export
|
|
213
|
+
* @interface AuthorizationInPaymentsEntity
|
|
214
|
+
*/
|
|
215
|
+
export interface AuthorizationInPaymentsEntity {
|
|
216
|
+
/**
|
|
217
|
+
* One of CAPTURE or VOID
|
|
218
|
+
* @type {string}
|
|
219
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
220
|
+
*/
|
|
221
|
+
'action'?: AuthorizationInPaymentsEntityActionEnum;
|
|
222
|
+
/**
|
|
223
|
+
* One of SUCCESS or PENDING
|
|
224
|
+
* @type {string}
|
|
225
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
226
|
+
*/
|
|
227
|
+
'status'?: AuthorizationInPaymentsEntityStatusEnum;
|
|
228
|
+
/**
|
|
229
|
+
* The captured amount for this authorization request
|
|
230
|
+
* @type {number}
|
|
231
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
232
|
+
*/
|
|
233
|
+
'captured_amount'?: number;
|
|
234
|
+
/**
|
|
235
|
+
* Start time of this authorization hold (only for UPI)
|
|
236
|
+
* @type {string}
|
|
237
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
238
|
+
*/
|
|
239
|
+
'start_time'?: string;
|
|
240
|
+
/**
|
|
241
|
+
* End time of this authorization hold (only for UPI)
|
|
242
|
+
* @type {string}
|
|
243
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
244
|
+
*/
|
|
245
|
+
'end_time'?: string;
|
|
246
|
+
/**
|
|
247
|
+
* Approve by time as passed in the authorization request (only for UPI)
|
|
248
|
+
* @type {string}
|
|
249
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
250
|
+
*/
|
|
251
|
+
'approve_by'?: string;
|
|
252
|
+
/**
|
|
253
|
+
* CAPTURE or VOID reference number based on action
|
|
254
|
+
* @type {string}
|
|
255
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
256
|
+
*/
|
|
257
|
+
'action_reference'?: string;
|
|
258
|
+
/**
|
|
259
|
+
* Time of action (CAPTURE or VOID)
|
|
260
|
+
* @type {string}
|
|
261
|
+
* @memberof AuthorizationInPaymentsEntity
|
|
262
|
+
*/
|
|
263
|
+
'action_time'?: string;
|
|
264
|
+
}
|
|
265
|
+
export declare const AuthorizationInPaymentsEntityActionEnum: {
|
|
266
|
+
readonly CAPTURE: "CAPTURE";
|
|
267
|
+
readonly VOID: "VOID";
|
|
268
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
269
|
+
};
|
|
270
|
+
export type AuthorizationInPaymentsEntityActionEnum = typeof AuthorizationInPaymentsEntityActionEnum[keyof typeof AuthorizationInPaymentsEntityActionEnum];
|
|
271
|
+
export declare const AuthorizationInPaymentsEntityStatusEnum: {
|
|
272
|
+
readonly SUCCESS: "SUCCESS";
|
|
273
|
+
readonly PENDING: "PENDING";
|
|
274
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
275
|
+
};
|
|
276
|
+
export type AuthorizationInPaymentsEntityStatusEnum = typeof AuthorizationInPaymentsEntityStatusEnum[keyof typeof AuthorizationInPaymentsEntityStatusEnum];
|
|
277
|
+
/**
|
|
278
|
+
* Request to capture or void transaction
|
|
279
|
+
* @export
|
|
280
|
+
* @interface AuthorizeOrderRequest
|
|
281
|
+
*/
|
|
282
|
+
export interface AuthorizeOrderRequest {
|
|
283
|
+
/**
|
|
284
|
+
* Type of authorization to run. Can be one of \'CAPTURE\' , \'VOID\'
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof AuthorizeOrderRequest
|
|
287
|
+
*/
|
|
288
|
+
'action'?: AuthorizeOrderRequestActionEnum;
|
|
289
|
+
/**
|
|
290
|
+
* The amount if you are running a \'CAPTURE\'
|
|
291
|
+
* @type {number}
|
|
292
|
+
* @memberof AuthorizeOrderRequest
|
|
293
|
+
*/
|
|
294
|
+
'amount'?: number;
|
|
295
|
+
}
|
|
296
|
+
export declare const AuthorizeOrderRequestActionEnum: {
|
|
297
|
+
readonly CAPTURE: "CAPTURE";
|
|
298
|
+
readonly VOID: "VOID";
|
|
299
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
300
|
+
};
|
|
301
|
+
export type AuthorizeOrderRequestActionEnum = typeof AuthorizeOrderRequestActionEnum[keyof typeof AuthorizeOrderRequestActionEnum];
|
|
302
|
+
/**
|
|
303
|
+
* Invalid request received from client
|
|
304
|
+
* @export
|
|
305
|
+
* @interface BadRequestError
|
|
306
|
+
*/
|
|
307
|
+
export interface BadRequestError {
|
|
308
|
+
/**
|
|
309
|
+
*
|
|
310
|
+
* @type {string}
|
|
311
|
+
* @memberof BadRequestError
|
|
312
|
+
*/
|
|
313
|
+
'message'?: string;
|
|
314
|
+
/**
|
|
315
|
+
*
|
|
316
|
+
* @type {string}
|
|
317
|
+
* @memberof BadRequestError
|
|
318
|
+
*/
|
|
319
|
+
'code'?: string;
|
|
320
|
+
/**
|
|
321
|
+
*
|
|
322
|
+
* @type {string}
|
|
323
|
+
* @memberof BadRequestError
|
|
324
|
+
*/
|
|
325
|
+
'type'?: BadRequestErrorTypeEnum;
|
|
326
|
+
}
|
|
327
|
+
export declare const BadRequestErrorTypeEnum: {
|
|
328
|
+
readonly INVALID_REQUEST_ERROR: "invalid_request_error";
|
|
329
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
330
|
+
};
|
|
331
|
+
export type BadRequestErrorTypeEnum = typeof BadRequestErrorTypeEnum[keyof typeof BadRequestErrorTypeEnum];
|
|
332
|
+
/**
|
|
333
|
+
* Card Payment method
|
|
334
|
+
* @export
|
|
335
|
+
* @interface Card
|
|
336
|
+
*/
|
|
337
|
+
export interface Card {
|
|
338
|
+
/**
|
|
339
|
+
* The channel for card payments can be \"link\" or \"post\". Post is used for seamless OTP payments where merchant captures OTP on their own page.
|
|
340
|
+
* @type {string}
|
|
341
|
+
* @memberof Card
|
|
342
|
+
*/
|
|
343
|
+
'channel'?: CardChannelEnum;
|
|
344
|
+
/**
|
|
345
|
+
* Customer card number for plain card transactions. Token pan number for tokenized card transactions.
|
|
346
|
+
* @type {string}
|
|
347
|
+
* @memberof Card
|
|
348
|
+
*/
|
|
349
|
+
'card_number'?: string;
|
|
350
|
+
/**
|
|
351
|
+
* Customer name mentioned on the card.
|
|
352
|
+
* @type {string}
|
|
353
|
+
* @memberof Card
|
|
354
|
+
*/
|
|
355
|
+
'card_holder_name'?: string;
|
|
356
|
+
/**
|
|
357
|
+
* Card expiry month for plain card transactions. Token expiry month for tokenized card transactions.
|
|
358
|
+
* @type {string}
|
|
359
|
+
* @memberof Card
|
|
360
|
+
*/
|
|
361
|
+
'card_expiry_mm'?: string;
|
|
362
|
+
/**
|
|
363
|
+
* Card expiry year for plain card transactions. Token expiry year for tokenized card transactions.
|
|
364
|
+
* @type {string}
|
|
365
|
+
* @memberof Card
|
|
366
|
+
*/
|
|
367
|
+
'card_expiry_yy'?: string;
|
|
368
|
+
/**
|
|
369
|
+
* CVV mentioned on the card.
|
|
370
|
+
* @type {string}
|
|
371
|
+
* @memberof Card
|
|
372
|
+
*/
|
|
373
|
+
'card_cvv'?: string;
|
|
374
|
+
/**
|
|
375
|
+
* instrument id of saved card. Required only to make payment using saved instrument.
|
|
376
|
+
* @type {string}
|
|
377
|
+
* @memberof Card
|
|
378
|
+
*/
|
|
379
|
+
'instrument_id'?: string;
|
|
380
|
+
/**
|
|
381
|
+
* cryptogram received from card network. Required only for tokenized card transactions.
|
|
382
|
+
* @type {string}
|
|
383
|
+
* @memberof Card
|
|
384
|
+
*/
|
|
385
|
+
'cryptogram'?: string;
|
|
386
|
+
/**
|
|
387
|
+
* TRID issued by card networks. Required only for tokenized card transactions.
|
|
388
|
+
* @type {string}
|
|
389
|
+
* @memberof Card
|
|
390
|
+
*/
|
|
391
|
+
'token_requestor_id'?: string;
|
|
392
|
+
/**
|
|
393
|
+
*
|
|
394
|
+
* @type {string}
|
|
395
|
+
* @memberof Card
|
|
396
|
+
*/
|
|
397
|
+
'token_type'?: CardTokenTypeEnum;
|
|
398
|
+
/**
|
|
399
|
+
* last 4 digits of original card number. Required only for tokenized card transactions.
|
|
400
|
+
* @type {string}
|
|
401
|
+
* @memberof Card
|
|
402
|
+
*/
|
|
403
|
+
'card_display'?: string;
|
|
404
|
+
/**
|
|
405
|
+
* Card alias as returned by Cashfree Vault API.
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof Card
|
|
408
|
+
*/
|
|
409
|
+
'card_alias'?: string;
|
|
410
|
+
/**
|
|
411
|
+
* One of [\"Kotak\", \"ICICI\", \"RBL\", \"BOB\", \"Standard Chartered\"]. Card bank name, required for EMI payments. This is the bank user has selected for EMI
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof Card
|
|
414
|
+
*/
|
|
415
|
+
'card_bank_name'?: CardCardBankNameEnum;
|
|
416
|
+
/**
|
|
417
|
+
* EMI tenure selected by the user
|
|
418
|
+
* @type {number}
|
|
419
|
+
* @memberof Card
|
|
420
|
+
*/
|
|
421
|
+
'emi_tenure'?: number;
|
|
422
|
+
}
|
|
423
|
+
export declare const CardChannelEnum: {
|
|
424
|
+
readonly LINK: "link";
|
|
425
|
+
readonly POST: "post";
|
|
426
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
427
|
+
};
|
|
428
|
+
export type CardChannelEnum = typeof CardChannelEnum[keyof typeof CardChannelEnum];
|
|
429
|
+
export declare const CardTokenTypeEnum: {
|
|
430
|
+
readonly ISSUER_TOKEN: "ISSUER_TOKEN";
|
|
431
|
+
readonly NETWORK_GC_TOKEN: "NETWORK_GC_TOKEN";
|
|
432
|
+
readonly ISSUER_GC_TOKEN: "ISSUER_GC_TOKEN";
|
|
433
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
434
|
+
};
|
|
435
|
+
export type CardTokenTypeEnum = typeof CardTokenTypeEnum[keyof typeof CardTokenTypeEnum];
|
|
436
|
+
export declare const CardCardBankNameEnum: {
|
|
437
|
+
readonly KOTAK: "Kotak";
|
|
438
|
+
readonly ICICI: "ICICI";
|
|
439
|
+
readonly RBL: "RBL";
|
|
440
|
+
readonly BOB: "BOB";
|
|
441
|
+
readonly STANDARD_CHARTERED: "Standard Chartered";
|
|
442
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
443
|
+
};
|
|
444
|
+
export type CardCardBankNameEnum = typeof CardCardBankNameEnum[keyof typeof CardCardBankNameEnum];
|
|
445
|
+
/**
|
|
446
|
+
* Payment method for card emi
|
|
447
|
+
* @export
|
|
448
|
+
* @interface CardEMI
|
|
449
|
+
*/
|
|
450
|
+
export interface CardEMI {
|
|
451
|
+
/**
|
|
452
|
+
* The channel for card payments will always be \"link\"
|
|
453
|
+
* @type {string}
|
|
454
|
+
* @memberof CardEMI
|
|
455
|
+
*/
|
|
456
|
+
'channel'?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Customer card number.
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof CardEMI
|
|
461
|
+
*/
|
|
462
|
+
'card_number'?: string;
|
|
463
|
+
/**
|
|
464
|
+
* Customer name mentioned on the card.
|
|
465
|
+
* @type {string}
|
|
466
|
+
* @memberof CardEMI
|
|
467
|
+
*/
|
|
468
|
+
'card_holder_name'?: string;
|
|
469
|
+
/**
|
|
470
|
+
* Card expiry month.
|
|
471
|
+
* @type {string}
|
|
472
|
+
* @memberof CardEMI
|
|
473
|
+
*/
|
|
474
|
+
'card_expiry_mm'?: string;
|
|
475
|
+
/**
|
|
476
|
+
* Card expiry year.
|
|
477
|
+
* @type {string}
|
|
478
|
+
* @memberof CardEMI
|
|
479
|
+
*/
|
|
480
|
+
'card_expiry_yy'?: string;
|
|
481
|
+
/**
|
|
482
|
+
* CVV mentioned on the card.
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof CardEMI
|
|
485
|
+
*/
|
|
486
|
+
'card_cvv'?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Card alias as returned by Cashfree Vault API
|
|
489
|
+
* @type {string}
|
|
490
|
+
* @memberof CardEMI
|
|
491
|
+
*/
|
|
492
|
+
'card_alias'?: string;
|
|
493
|
+
/**
|
|
494
|
+
* Card bank name, required for EMI payments. This is the bank user has selected for EMI. One of [\"hdfc, \"kotak\", \"icici\", \"rbl\", \"bob\", \"standard chartered\", \"axis\", \"au\", \"yes\", \"sbi\", \"fed\", \"hsbc\", \"citi\", \"amex\"]
|
|
495
|
+
* @type {string}
|
|
496
|
+
* @memberof CardEMI
|
|
497
|
+
*/
|
|
498
|
+
'card_bank_name'?: CardEMICardBankNameEnum;
|
|
499
|
+
/**
|
|
500
|
+
* EMI tenure selected by the user
|
|
501
|
+
* @type {number}
|
|
502
|
+
* @memberof CardEMI
|
|
503
|
+
*/
|
|
504
|
+
'emi_tenure'?: number;
|
|
505
|
+
}
|
|
506
|
+
export declare const CardEMICardBankNameEnum: {
|
|
507
|
+
readonly HDFC: "hdfc";
|
|
508
|
+
readonly KOTAK: "kotak";
|
|
509
|
+
readonly ICICI: "icici";
|
|
510
|
+
readonly RBL: "rbl";
|
|
511
|
+
readonly BOB: "bob";
|
|
512
|
+
readonly STANDARD_CHARTERED: "standard chartered";
|
|
513
|
+
readonly AXIS: "axis";
|
|
514
|
+
readonly AU: "au";
|
|
515
|
+
readonly YES: "yes";
|
|
516
|
+
readonly SBI: "sbi";
|
|
517
|
+
readonly FED: "fed";
|
|
518
|
+
readonly HSBC: "hsbc";
|
|
519
|
+
readonly CITI: "citi";
|
|
520
|
+
readonly AMEX: "amex";
|
|
521
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
522
|
+
};
|
|
523
|
+
export type CardEMICardBankNameEnum = typeof CardEMICardBankNameEnum[keyof typeof CardEMICardBankNameEnum];
|
|
524
|
+
/**
|
|
525
|
+
* Complete card emi payment method
|
|
526
|
+
* @export
|
|
527
|
+
* @interface CardEMIPaymentMethod
|
|
528
|
+
*/
|
|
529
|
+
export interface CardEMIPaymentMethod {
|
|
530
|
+
/**
|
|
531
|
+
*
|
|
532
|
+
* @type {CardEMI}
|
|
533
|
+
* @memberof CardEMIPaymentMethod
|
|
534
|
+
*/
|
|
535
|
+
'emi': CardEMI;
|
|
536
|
+
}
|
|
537
|
+
/**
|
|
538
|
+
*
|
|
539
|
+
* @export
|
|
540
|
+
* @interface CardOffer
|
|
541
|
+
*/
|
|
542
|
+
export interface CardOffer {
|
|
543
|
+
/**
|
|
544
|
+
*
|
|
545
|
+
* @type {Array<string>}
|
|
546
|
+
* @memberof CardOffer
|
|
547
|
+
*/
|
|
548
|
+
'type': Array<string>;
|
|
549
|
+
/**
|
|
550
|
+
* Bank Name of Card.
|
|
551
|
+
* @type {string}
|
|
552
|
+
* @memberof CardOffer
|
|
553
|
+
*/
|
|
554
|
+
'bank_name': string;
|
|
555
|
+
/**
|
|
556
|
+
*
|
|
557
|
+
* @type {Array<string>}
|
|
558
|
+
* @memberof CardOffer
|
|
559
|
+
*/
|
|
560
|
+
'scheme_name': Array<string>;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* The card payment object is used to make payment using either plain card number, saved card instrument id or using cryptogram
|
|
564
|
+
* @export
|
|
565
|
+
* @interface CardPaymentMethod
|
|
566
|
+
*/
|
|
567
|
+
export interface CardPaymentMethod {
|
|
568
|
+
/**
|
|
569
|
+
*
|
|
570
|
+
* @type {Card}
|
|
571
|
+
* @memberof CardPaymentMethod
|
|
572
|
+
*/
|
|
573
|
+
'card': Card;
|
|
574
|
+
}
|
|
575
|
+
/**
|
|
576
|
+
* Request body for cardless emi payment method
|
|
577
|
+
* @export
|
|
578
|
+
* @interface CardlessEMI
|
|
579
|
+
*/
|
|
580
|
+
export interface CardlessEMI {
|
|
581
|
+
/**
|
|
582
|
+
* The channel for cardless EMI is always `link`
|
|
583
|
+
* @type {string}
|
|
584
|
+
* @memberof CardlessEMI
|
|
585
|
+
*/
|
|
586
|
+
'channel'?: string;
|
|
587
|
+
/**
|
|
588
|
+
* One of [`flexmoney`, `zestmoney`, `hdfc`, `icici`, `cashe`, `idfc`, `kotak`]
|
|
589
|
+
* @type {string}
|
|
590
|
+
* @memberof CardlessEMI
|
|
591
|
+
*/
|
|
592
|
+
'provider'?: CardlessEMIProviderEnum;
|
|
593
|
+
/**
|
|
594
|
+
* Customers phone number for this payment instrument. If the customer is not eligible you will receive a 400 error with type as \'invalid_request_error\' and code as \'invalid_request_error\'
|
|
595
|
+
* @type {string}
|
|
596
|
+
* @memberof CardlessEMI
|
|
597
|
+
*/
|
|
598
|
+
'phone'?: string;
|
|
599
|
+
/**
|
|
600
|
+
* EMI tenure for the selected provider. This is mandatory when provider is one of [`hdfc`, `icici`, `cashe`, `idfc`, `kotak`]
|
|
601
|
+
* @type {number}
|
|
602
|
+
* @memberof CardlessEMI
|
|
603
|
+
*/
|
|
604
|
+
'emi_tenure'?: number;
|
|
605
|
+
}
|
|
606
|
+
export declare const CardlessEMIProviderEnum: {
|
|
607
|
+
readonly FLEXMONEY: "flexmoney";
|
|
608
|
+
readonly ZESTMONEY: "zestmoney";
|
|
609
|
+
readonly HDFC: "hdfc";
|
|
610
|
+
readonly ICICI: "icici";
|
|
611
|
+
readonly CASHE: "cashe";
|
|
612
|
+
readonly IDFC: "idfc";
|
|
613
|
+
readonly KOTAK: "kotak";
|
|
614
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
615
|
+
};
|
|
616
|
+
export type CardlessEMIProviderEnum = typeof CardlessEMIProviderEnum[keyof typeof CardlessEMIProviderEnum];
|
|
617
|
+
/**
|
|
618
|
+
* cardless EMI object
|
|
619
|
+
* @export
|
|
620
|
+
* @interface CardlessEMIEntity
|
|
621
|
+
*/
|
|
622
|
+
export interface CardlessEMIEntity {
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @type {string}
|
|
626
|
+
* @memberof CardlessEMIEntity
|
|
627
|
+
*/
|
|
628
|
+
'payment_method'?: string;
|
|
629
|
+
/**
|
|
630
|
+
*
|
|
631
|
+
* @type {Array<EMIPlansArray>}
|
|
632
|
+
* @memberof CardlessEMIEntity
|
|
633
|
+
*/
|
|
634
|
+
'emi_plans'?: Array<EMIPlansArray>;
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* cardless EMI payment method object
|
|
638
|
+
* @export
|
|
639
|
+
* @interface CardlessEMIPaymentMethod
|
|
640
|
+
*/
|
|
641
|
+
export interface CardlessEMIPaymentMethod {
|
|
642
|
+
/**
|
|
643
|
+
*
|
|
644
|
+
* @type {CardlessEMI}
|
|
645
|
+
* @memberof CardlessEMIPaymentMethod
|
|
646
|
+
*/
|
|
647
|
+
'cardless_emi'?: CardlessEMI;
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* cardless EMI query object
|
|
651
|
+
* @export
|
|
652
|
+
* @interface CardlessEMIQueries
|
|
653
|
+
*/
|
|
654
|
+
export interface CardlessEMIQueries {
|
|
655
|
+
/**
|
|
656
|
+
* OrderId of the order. Either of `order_id` or `amount` is mandatory.
|
|
657
|
+
* @type {string}
|
|
658
|
+
* @memberof CardlessEMIQueries
|
|
659
|
+
*/
|
|
660
|
+
'order_id'?: string;
|
|
661
|
+
/**
|
|
662
|
+
* Amount of the order. OrderId of the order. Either of `order_id` or `amount` is mandatory.
|
|
663
|
+
* @type {number}
|
|
664
|
+
* @memberof CardlessEMIQueries
|
|
665
|
+
*/
|
|
666
|
+
'amount'?: number;
|
|
667
|
+
/**
|
|
668
|
+
*
|
|
669
|
+
* @type {CustomerDetailsCardlessEMI}
|
|
670
|
+
* @memberof CardlessEMIQueries
|
|
671
|
+
*/
|
|
672
|
+
'customer_details'?: CustomerDetailsCardlessEMI;
|
|
673
|
+
}
|
|
674
|
+
/**
|
|
675
|
+
* Cashback detail boject
|
|
676
|
+
* @export
|
|
677
|
+
* @interface CashbackDetails
|
|
678
|
+
*/
|
|
679
|
+
export interface CashbackDetails {
|
|
680
|
+
/**
|
|
681
|
+
* Type of discount
|
|
682
|
+
* @type {string}
|
|
683
|
+
* @memberof CashbackDetails
|
|
684
|
+
*/
|
|
685
|
+
'cashback_type': CashbackDetailsCashbackTypeEnum;
|
|
686
|
+
/**
|
|
687
|
+
* Value of Discount.
|
|
688
|
+
* @type {string}
|
|
689
|
+
* @memberof CashbackDetails
|
|
690
|
+
*/
|
|
691
|
+
'cashback_value': string;
|
|
692
|
+
/**
|
|
693
|
+
* Maximum Value of Cashback allowed.
|
|
694
|
+
* @type {string}
|
|
695
|
+
* @memberof CashbackDetails
|
|
696
|
+
*/
|
|
697
|
+
'max_cashback_amount': string;
|
|
698
|
+
}
|
|
699
|
+
export declare const CashbackDetailsCashbackTypeEnum: {
|
|
700
|
+
readonly FLAT: "flat";
|
|
701
|
+
readonly PERCENTAGE: "percentage";
|
|
702
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
703
|
+
};
|
|
704
|
+
export type CashbackDetailsCashbackTypeEnum = typeof CashbackDetailsCashbackTypeEnum[keyof typeof CashbackDetailsCashbackTypeEnum];
|
|
705
|
+
/**
|
|
706
|
+
* Request paramenters for link creation
|
|
707
|
+
* @export
|
|
708
|
+
* @interface CreateLinkRequest
|
|
709
|
+
*/
|
|
710
|
+
export interface CreateLinkRequest {
|
|
711
|
+
/**
|
|
712
|
+
* Unique Identifier (provided by merchant) for the Link. Alphanumeric and only - and _ allowed (50 character limit). Use this for other link-related APIs.
|
|
713
|
+
* @type {string}
|
|
714
|
+
* @memberof CreateLinkRequest
|
|
715
|
+
*/
|
|
716
|
+
'link_id': string;
|
|
717
|
+
/**
|
|
718
|
+
* Amount to be collected using this link. Provide upto two decimals for paise.
|
|
719
|
+
* @type {number}
|
|
720
|
+
* @memberof CreateLinkRequest
|
|
721
|
+
*/
|
|
722
|
+
'link_amount': number;
|
|
723
|
+
/**
|
|
724
|
+
* Currency for the payment link. Default is INR. Contact care@cashfree.com to enable new currencies.
|
|
725
|
+
* @type {string}
|
|
726
|
+
* @memberof CreateLinkRequest
|
|
727
|
+
*/
|
|
728
|
+
'link_currency': string;
|
|
729
|
+
/**
|
|
730
|
+
* A brief description for which payment must be collected. This is shown to the customer.
|
|
731
|
+
* @type {string}
|
|
732
|
+
* @memberof CreateLinkRequest
|
|
733
|
+
*/
|
|
734
|
+
'link_purpose': string;
|
|
735
|
+
/**
|
|
736
|
+
*
|
|
737
|
+
* @type {LinkCustomerDetailsEntity}
|
|
738
|
+
* @memberof CreateLinkRequest
|
|
739
|
+
*/
|
|
740
|
+
'customer_details': LinkCustomerDetailsEntity;
|
|
741
|
+
/**
|
|
742
|
+
* If \"true\", customer can make partial payments for the link.
|
|
743
|
+
* @type {boolean}
|
|
744
|
+
* @memberof CreateLinkRequest
|
|
745
|
+
*/
|
|
746
|
+
'link_partial_payments'?: boolean;
|
|
747
|
+
/**
|
|
748
|
+
* Minimum amount in first installment that needs to be paid by the customer if partial payments are enabled. This should be less than the link_amount.
|
|
749
|
+
* @type {number}
|
|
750
|
+
* @memberof CreateLinkRequest
|
|
751
|
+
*/
|
|
752
|
+
'link_minimum_partial_amount'?: number;
|
|
753
|
+
/**
|
|
754
|
+
* Time after which the link expires. Customers will not be able to make the payment beyond the time specified here. You can provide them in a valid ISO 8601 time format. Default is 30 days.
|
|
755
|
+
* @type {string}
|
|
756
|
+
* @memberof CreateLinkRequest
|
|
757
|
+
*/
|
|
758
|
+
'link_expiry_time'?: string;
|
|
759
|
+
/**
|
|
760
|
+
*
|
|
761
|
+
* @type {LinkNotifyEntity}
|
|
762
|
+
* @memberof CreateLinkRequest
|
|
763
|
+
*/
|
|
764
|
+
'link_notify'?: LinkNotifyEntity;
|
|
765
|
+
/**
|
|
766
|
+
* If \"true\", reminders will be sent to customers for collecting payments.
|
|
767
|
+
* @type {boolean}
|
|
768
|
+
* @memberof CreateLinkRequest
|
|
769
|
+
*/
|
|
770
|
+
'link_auto_reminders'?: boolean;
|
|
771
|
+
/**
|
|
772
|
+
* Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs
|
|
773
|
+
* @type {{ [key: string]: string; }}
|
|
774
|
+
* @memberof CreateLinkRequest
|
|
775
|
+
*/
|
|
776
|
+
'link_notes'?: {
|
|
777
|
+
[key: string]: string;
|
|
778
|
+
};
|
|
779
|
+
/**
|
|
780
|
+
*
|
|
781
|
+
* @type {LinkMetaEntity}
|
|
782
|
+
* @memberof CreateLinkRequest
|
|
783
|
+
*/
|
|
784
|
+
'link_meta'?: LinkMetaEntity;
|
|
785
|
+
}
|
|
786
|
+
/**
|
|
787
|
+
* create offer backend request object
|
|
788
|
+
* @export
|
|
789
|
+
* @interface CreateOfferRequest
|
|
790
|
+
*/
|
|
791
|
+
export interface CreateOfferRequest {
|
|
792
|
+
/**
|
|
793
|
+
*
|
|
794
|
+
* @type {OfferMeta}
|
|
795
|
+
* @memberof CreateOfferRequest
|
|
796
|
+
*/
|
|
797
|
+
'offer_meta': OfferMeta;
|
|
798
|
+
/**
|
|
799
|
+
*
|
|
800
|
+
* @type {OfferTnc}
|
|
801
|
+
* @memberof CreateOfferRequest
|
|
802
|
+
*/
|
|
803
|
+
'offer_tnc': OfferTnc;
|
|
804
|
+
/**
|
|
805
|
+
*
|
|
806
|
+
* @type {OfferDetails}
|
|
807
|
+
* @memberof CreateOfferRequest
|
|
808
|
+
*/
|
|
809
|
+
'offer_details': OfferDetails;
|
|
810
|
+
/**
|
|
811
|
+
*
|
|
812
|
+
* @type {OfferValidations}
|
|
813
|
+
* @memberof CreateOfferRequest
|
|
814
|
+
*/
|
|
815
|
+
'offer_validations': OfferValidations;
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* Request body to create an order at cashfree
|
|
819
|
+
* @export
|
|
820
|
+
* @interface CreateOrderRequest
|
|
821
|
+
*/
|
|
822
|
+
export interface CreateOrderRequest {
|
|
823
|
+
/**
|
|
824
|
+
* Order identifier present in your system. Alphanumeric, \'_\' and \'-\' only
|
|
825
|
+
* @type {string}
|
|
826
|
+
* @memberof CreateOrderRequest
|
|
827
|
+
*/
|
|
828
|
+
'order_id'?: string | null;
|
|
829
|
+
/**
|
|
830
|
+
* Bill amount for the order. Provide upto two decimals. 10.15 means Rs 10 and 15 paisa
|
|
831
|
+
* @type {number}
|
|
832
|
+
* @memberof CreateOrderRequest
|
|
833
|
+
*/
|
|
834
|
+
'order_amount': number;
|
|
835
|
+
/**
|
|
836
|
+
* Currency for the order. INR if left empty. Contact care@cashfree.com to enable new currencies.
|
|
837
|
+
* @type {string}
|
|
838
|
+
* @memberof CreateOrderRequest
|
|
839
|
+
*/
|
|
840
|
+
'order_currency': string;
|
|
841
|
+
/**
|
|
842
|
+
*
|
|
843
|
+
* @type {CustomerDetails}
|
|
844
|
+
* @memberof CreateOrderRequest
|
|
845
|
+
*/
|
|
846
|
+
'customer_details': CustomerDetails;
|
|
847
|
+
/**
|
|
848
|
+
*
|
|
849
|
+
* @type {CreateOrderRequestTerminal}
|
|
850
|
+
* @memberof CreateOrderRequest
|
|
851
|
+
*/
|
|
852
|
+
'terminal'?: CreateOrderRequestTerminal | null;
|
|
853
|
+
/**
|
|
854
|
+
*
|
|
855
|
+
* @type {CreateOrderRequestOrderMeta}
|
|
856
|
+
* @memberof CreateOrderRequest
|
|
857
|
+
*/
|
|
858
|
+
'order_meta'?: CreateOrderRequestOrderMeta | null;
|
|
859
|
+
/**
|
|
860
|
+
* Time after which the order expires. Customers will not be able to make the payment beyond the time specified here. We store timestamps in IST, but you can provide them in a valid ISO 8601 time format. Example 2021-07-02T10:20:12+05:30 for IST, 2021-07-02T10:20:12Z for UTC
|
|
861
|
+
* @type {string}
|
|
862
|
+
* @memberof CreateOrderRequest
|
|
863
|
+
*/
|
|
864
|
+
'order_expiry_time'?: string;
|
|
865
|
+
/**
|
|
866
|
+
* Order note for reference.
|
|
867
|
+
* @type {string}
|
|
868
|
+
* @memberof CreateOrderRequest
|
|
869
|
+
*/
|
|
870
|
+
'order_note'?: string | null;
|
|
871
|
+
/**
|
|
872
|
+
* Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added
|
|
873
|
+
* @type {{ [key: string]: string; }}
|
|
874
|
+
* @memberof CreateOrderRequest
|
|
875
|
+
*/
|
|
876
|
+
'order_tags'?: {
|
|
877
|
+
[key: string]: string;
|
|
878
|
+
} | null;
|
|
879
|
+
/**
|
|
880
|
+
* If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount.
|
|
881
|
+
* @type {Array<VendorSplit>}
|
|
882
|
+
* @memberof CreateOrderRequest
|
|
883
|
+
*/
|
|
884
|
+
'order_splits'?: Array<VendorSplit> | null;
|
|
885
|
+
}
|
|
886
|
+
/**
|
|
887
|
+
*
|
|
888
|
+
* @export
|
|
889
|
+
* @interface CreateOrderRequestOrderMeta
|
|
890
|
+
*/
|
|
891
|
+
export interface CreateOrderRequestOrderMeta {
|
|
892
|
+
/**
|
|
893
|
+
* The URL to which user will be redirected to after the payment on bank OTP page. Maximum length: 250. The return_url must contain placeholder {order_id}. When redirecting the customer back to the return url from the bank’s OTP page, Cashfree will replace this placeholder with the actual value for that order.
|
|
894
|
+
* @type {string}
|
|
895
|
+
* @memberof CreateOrderRequestOrderMeta
|
|
896
|
+
*/
|
|
897
|
+
'return_url'?: string | null;
|
|
898
|
+
/**
|
|
899
|
+
* Notification URL for server-server communication. Useful when user\'s connection drops while re-directing. NotifyUrl should be an https URL. Maximum length: 250.
|
|
900
|
+
* @type {string}
|
|
901
|
+
* @memberof CreateOrderRequestOrderMeta
|
|
902
|
+
*/
|
|
903
|
+
'notify_url'?: string | null;
|
|
904
|
+
/**
|
|
905
|
+
* Allowed payment modes for this order. Pass comma-separated values among following options - \"cc\", \"dc\", \"ccc\", \"ppc\",\"nb\",\"upi\",\"paypal\",\"app\",\"paylater\",\"cardlessemi\",\"dcemi\",\"ccemi\",\"banktransfer\". Leave it blank to show all available payment methods
|
|
906
|
+
* @type {any}
|
|
907
|
+
* @memberof CreateOrderRequestOrderMeta
|
|
908
|
+
*/
|
|
909
|
+
'payment_methods'?: any | null;
|
|
910
|
+
}
|
|
911
|
+
/**
|
|
912
|
+
*
|
|
913
|
+
* @export
|
|
914
|
+
* @interface CreateOrderRequestTerminal
|
|
915
|
+
*/
|
|
916
|
+
export interface CreateOrderRequestTerminal {
|
|
917
|
+
/**
|
|
918
|
+
* date time at which terminal is added
|
|
919
|
+
* @type {string}
|
|
920
|
+
* @memberof CreateOrderRequestTerminal
|
|
921
|
+
*/
|
|
922
|
+
'added_on'?: string;
|
|
923
|
+
/**
|
|
924
|
+
* cashfree terminal id
|
|
925
|
+
* @type {number}
|
|
926
|
+
* @memberof CreateOrderRequestTerminal
|
|
927
|
+
*/
|
|
928
|
+
'cf_terminal_id'?: number;
|
|
929
|
+
/**
|
|
930
|
+
* last instant when this terminal was updated
|
|
931
|
+
* @type {string}
|
|
932
|
+
* @memberof CreateOrderRequestTerminal
|
|
933
|
+
*/
|
|
934
|
+
'last_updated_on'?: string;
|
|
935
|
+
/**
|
|
936
|
+
* location of terminal
|
|
937
|
+
* @type {string}
|
|
938
|
+
* @memberof CreateOrderRequestTerminal
|
|
939
|
+
*/
|
|
940
|
+
'terminal_address'?: string;
|
|
941
|
+
/**
|
|
942
|
+
* terminal id for merchant reference
|
|
943
|
+
* @type {string}
|
|
944
|
+
* @memberof CreateOrderRequestTerminal
|
|
945
|
+
*/
|
|
946
|
+
'terminal_id': string;
|
|
947
|
+
/**
|
|
948
|
+
* name of terminal/agent/storefront
|
|
949
|
+
* @type {string}
|
|
950
|
+
* @memberof CreateOrderRequestTerminal
|
|
951
|
+
*/
|
|
952
|
+
'terminal_name'?: string;
|
|
953
|
+
/**
|
|
954
|
+
* note given by merchant while creating the terminal
|
|
955
|
+
* @type {string}
|
|
956
|
+
* @memberof CreateOrderRequestTerminal
|
|
957
|
+
*/
|
|
958
|
+
'terminal_note'?: string;
|
|
959
|
+
/**
|
|
960
|
+
* mobile num of the terminal/agent/storefront
|
|
961
|
+
* @type {string}
|
|
962
|
+
* @memberof CreateOrderRequestTerminal
|
|
963
|
+
*/
|
|
964
|
+
'terminal_phone_no': string;
|
|
965
|
+
/**
|
|
966
|
+
* status of terminal active/inactive
|
|
967
|
+
* @type {string}
|
|
968
|
+
* @memberof CreateOrderRequestTerminal
|
|
969
|
+
*/
|
|
970
|
+
'terminal_status'?: string;
|
|
971
|
+
/**
|
|
972
|
+
* To identify the type of terminal product in use, in this case it is SPOS.
|
|
973
|
+
* @type {string}
|
|
974
|
+
* @memberof CreateOrderRequestTerminal
|
|
975
|
+
*/
|
|
976
|
+
'terminal_type': string;
|
|
977
|
+
}
|
|
978
|
+
/**
|
|
979
|
+
* Request body to create a terminal
|
|
980
|
+
* @export
|
|
981
|
+
* @interface CreateTerminalRequest
|
|
982
|
+
*/
|
|
983
|
+
export interface CreateTerminalRequest {
|
|
984
|
+
/**
|
|
985
|
+
* merchant’s internal terminal id
|
|
986
|
+
* @type {string}
|
|
987
|
+
* @memberof CreateTerminalRequest
|
|
988
|
+
*/
|
|
989
|
+
'terminal_id': string;
|
|
990
|
+
/**
|
|
991
|
+
* phone number assigned to the terminal
|
|
992
|
+
* @type {string}
|
|
993
|
+
* @memberof CreateTerminalRequest
|
|
994
|
+
*/
|
|
995
|
+
'terminal_phone_no': string;
|
|
996
|
+
/**
|
|
997
|
+
* terminal name to be assigned by merchants
|
|
998
|
+
* @type {string}
|
|
999
|
+
* @memberof CreateTerminalRequest
|
|
1000
|
+
*/
|
|
1001
|
+
'terminal_name': string;
|
|
1002
|
+
/**
|
|
1003
|
+
* address of the terminal. required for STOREFRONT
|
|
1004
|
+
* @type {string}
|
|
1005
|
+
* @memberof CreateTerminalRequest
|
|
1006
|
+
*/
|
|
1007
|
+
'terminal_address'?: string;
|
|
1008
|
+
/**
|
|
1009
|
+
* terminal email ID of the AGENT/STOREFRONT assigned by merchants.
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof CreateTerminalRequest
|
|
1012
|
+
*/
|
|
1013
|
+
'terminal_email': string;
|
|
1014
|
+
/**
|
|
1015
|
+
* additional note for terminal
|
|
1016
|
+
* @type {string}
|
|
1017
|
+
* @memberof CreateTerminalRequest
|
|
1018
|
+
*/
|
|
1019
|
+
'terminal_note'?: string;
|
|
1020
|
+
/**
|
|
1021
|
+
* mention the terminal type. possible values - AGENT, STOREFRONT.
|
|
1022
|
+
* @type {string}
|
|
1023
|
+
* @memberof CreateTerminalRequest
|
|
1024
|
+
*/
|
|
1025
|
+
'terminal_type': string;
|
|
1026
|
+
/**
|
|
1027
|
+
*
|
|
1028
|
+
* @type {CreateTerminalRequestTerminalMeta}
|
|
1029
|
+
* @memberof CreateTerminalRequest
|
|
1030
|
+
*/
|
|
1031
|
+
'terminal_meta'?: CreateTerminalRequestTerminalMeta;
|
|
1032
|
+
}
|
|
1033
|
+
/**
|
|
1034
|
+
* terminal metadata. required field for storefront.
|
|
1035
|
+
* @export
|
|
1036
|
+
* @interface CreateTerminalRequestTerminalMeta
|
|
1037
|
+
*/
|
|
1038
|
+
export interface CreateTerminalRequestTerminalMeta {
|
|
1039
|
+
/**
|
|
1040
|
+
* name of the STOREFRONT operator.
|
|
1041
|
+
* @type {string}
|
|
1042
|
+
* @memberof CreateTerminalRequestTerminalMeta
|
|
1043
|
+
*/
|
|
1044
|
+
'terminal_operator'?: string;
|
|
1045
|
+
}
|
|
1046
|
+
/**
|
|
1047
|
+
* Request body to create a terminal transaction
|
|
1048
|
+
* @export
|
|
1049
|
+
* @interface CreateTerminalTransactionRequest
|
|
1050
|
+
*/
|
|
1051
|
+
export interface CreateTerminalTransactionRequest {
|
|
1052
|
+
/**
|
|
1053
|
+
* cashfree order ID that was returned while creating an order.
|
|
1054
|
+
* @type {number}
|
|
1055
|
+
* @memberof CreateTerminalTransactionRequest
|
|
1056
|
+
*/
|
|
1057
|
+
'cf_order_id': number;
|
|
1058
|
+
/**
|
|
1059
|
+
* cashfree terminal id. this is a required parameter when you do not provide the terminal phone number.
|
|
1060
|
+
* @type {number}
|
|
1061
|
+
* @memberof CreateTerminalTransactionRequest
|
|
1062
|
+
*/
|
|
1063
|
+
'cf_terminal_id'?: number;
|
|
1064
|
+
/**
|
|
1065
|
+
* mention the payment method used for the transaction. possible values - QR_CODE, LINK.
|
|
1066
|
+
* @type {string}
|
|
1067
|
+
* @memberof CreateTerminalTransactionRequest
|
|
1068
|
+
*/
|
|
1069
|
+
'payment_method': string;
|
|
1070
|
+
/**
|
|
1071
|
+
* agent mobile number assigned to the terminal. this is a required parameter when you do not provide the cf_terminal_id.
|
|
1072
|
+
* @type {string}
|
|
1073
|
+
* @memberof CreateTerminalTransactionRequest
|
|
1074
|
+
*/
|
|
1075
|
+
'terminal_phone_no'?: string;
|
|
1076
|
+
}
|
|
1077
|
+
/**
|
|
1078
|
+
* Crytogram Card object
|
|
1079
|
+
* @export
|
|
1080
|
+
* @interface CryptogramEntity
|
|
1081
|
+
*/
|
|
1082
|
+
export interface CryptogramEntity {
|
|
1083
|
+
/**
|
|
1084
|
+
* instrument_id of saved instrument
|
|
1085
|
+
* @type {string}
|
|
1086
|
+
* @memberof CryptogramEntity
|
|
1087
|
+
*/
|
|
1088
|
+
'instrument_id'?: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* TRID issued by card networks
|
|
1091
|
+
* @type {string}
|
|
1092
|
+
* @memberof CryptogramEntity
|
|
1093
|
+
*/
|
|
1094
|
+
'token_requestor_id'?: string;
|
|
1095
|
+
/**
|
|
1096
|
+
* token pan number
|
|
1097
|
+
* @type {string}
|
|
1098
|
+
* @memberof CryptogramEntity
|
|
1099
|
+
*/
|
|
1100
|
+
'card_number'?: string;
|
|
1101
|
+
/**
|
|
1102
|
+
* token pan expiry month
|
|
1103
|
+
* @type {string}
|
|
1104
|
+
* @memberof CryptogramEntity
|
|
1105
|
+
*/
|
|
1106
|
+
'card_expiry_mm'?: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* token pan expiry year
|
|
1109
|
+
* @type {string}
|
|
1110
|
+
* @memberof CryptogramEntity
|
|
1111
|
+
*/
|
|
1112
|
+
'card_expiry_yy'?: string;
|
|
1113
|
+
/**
|
|
1114
|
+
* cryptogram
|
|
1115
|
+
* @type {string}
|
|
1116
|
+
* @memberof CryptogramEntity
|
|
1117
|
+
*/
|
|
1118
|
+
'cryptogram'?: string;
|
|
1119
|
+
/**
|
|
1120
|
+
* last 4 digits of original card number
|
|
1121
|
+
* @type {string}
|
|
1122
|
+
* @memberof CryptogramEntity
|
|
1123
|
+
*/
|
|
1124
|
+
'card_display'?: string;
|
|
1125
|
+
}
|
|
1126
|
+
/**
|
|
1127
|
+
* The customer details that are necessary. Note that you can pass dummy details if your use case does not require the customer details.
|
|
1128
|
+
* @export
|
|
1129
|
+
* @interface CustomerDetails
|
|
1130
|
+
*/
|
|
1131
|
+
export interface CustomerDetails {
|
|
1132
|
+
/**
|
|
1133
|
+
* A unique identifier for the customer. Use alphanumeric values only.
|
|
1134
|
+
* @type {string}
|
|
1135
|
+
* @memberof CustomerDetails
|
|
1136
|
+
*/
|
|
1137
|
+
'customer_id': string;
|
|
1138
|
+
/**
|
|
1139
|
+
* Customer email address.
|
|
1140
|
+
* @type {string}
|
|
1141
|
+
* @memberof CustomerDetails
|
|
1142
|
+
*/
|
|
1143
|
+
'customer_email'?: string | null;
|
|
1144
|
+
/**
|
|
1145
|
+
* Customer phone number.
|
|
1146
|
+
* @type {string}
|
|
1147
|
+
* @memberof CustomerDetails
|
|
1148
|
+
*/
|
|
1149
|
+
'customer_phone': string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Name of the customer.
|
|
1152
|
+
* @type {string}
|
|
1153
|
+
* @memberof CustomerDetails
|
|
1154
|
+
*/
|
|
1155
|
+
'customer_name'?: string | null;
|
|
1156
|
+
/**
|
|
1157
|
+
* Customer bank account. Required if you want to do a bank account check (TPV)
|
|
1158
|
+
* @type {string}
|
|
1159
|
+
* @memberof CustomerDetails
|
|
1160
|
+
*/
|
|
1161
|
+
'customer_bank_account_number'?: string | null;
|
|
1162
|
+
/**
|
|
1163
|
+
* Customer bank IFSC. Required if you want to do a bank account check (TPV)
|
|
1164
|
+
* @type {string}
|
|
1165
|
+
* @memberof CustomerDetails
|
|
1166
|
+
*/
|
|
1167
|
+
'customer_bank_ifsc'?: string | null;
|
|
1168
|
+
/**
|
|
1169
|
+
* Customer bank code. Required for net banking payments, if you want to do a bank account check (TPV)
|
|
1170
|
+
* @type {number}
|
|
1171
|
+
* @memberof CustomerDetails
|
|
1172
|
+
*/
|
|
1173
|
+
'customer_bank_code'?: number | null;
|
|
1174
|
+
}
|
|
1175
|
+
/**
|
|
1176
|
+
* Details of the customer for whom eligibility is being checked.
|
|
1177
|
+
* @export
|
|
1178
|
+
* @interface CustomerDetailsCardlessEMI
|
|
1179
|
+
*/
|
|
1180
|
+
export interface CustomerDetailsCardlessEMI {
|
|
1181
|
+
/**
|
|
1182
|
+
* Phone Number of the customer
|
|
1183
|
+
* @type {string}
|
|
1184
|
+
* @memberof CustomerDetailsCardlessEMI
|
|
1185
|
+
*/
|
|
1186
|
+
'customer_phone': string;
|
|
1187
|
+
}
|
|
1188
|
+
/**
|
|
1189
|
+
* detils of the discount object of offer
|
|
1190
|
+
* @export
|
|
1191
|
+
* @interface DiscountDetails
|
|
1192
|
+
*/
|
|
1193
|
+
export interface DiscountDetails {
|
|
1194
|
+
/**
|
|
1195
|
+
* Type of discount
|
|
1196
|
+
* @type {string}
|
|
1197
|
+
* @memberof DiscountDetails
|
|
1198
|
+
*/
|
|
1199
|
+
'discount_type': DiscountDetailsDiscountTypeEnum;
|
|
1200
|
+
/**
|
|
1201
|
+
* Value of Discount.
|
|
1202
|
+
* @type {string}
|
|
1203
|
+
* @memberof DiscountDetails
|
|
1204
|
+
*/
|
|
1205
|
+
'discount_value': string;
|
|
1206
|
+
/**
|
|
1207
|
+
* Maximum Value of Discount allowed.
|
|
1208
|
+
* @type {string}
|
|
1209
|
+
* @memberof DiscountDetails
|
|
1210
|
+
*/
|
|
1211
|
+
'max_discount_amount': string;
|
|
1212
|
+
}
|
|
1213
|
+
export declare const DiscountDetailsDiscountTypeEnum: {
|
|
1214
|
+
readonly FLAT: "flat";
|
|
1215
|
+
readonly PERCENTAGE: "percentage";
|
|
1216
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
1217
|
+
};
|
|
1218
|
+
export type DiscountDetailsDiscountTypeEnum = typeof DiscountDetailsDiscountTypeEnum[keyof typeof DiscountDetailsDiscountTypeEnum];
|
|
1219
|
+
/**
|
|
1220
|
+
*
|
|
1221
|
+
* @export
|
|
1222
|
+
* @interface EMIOffer
|
|
1223
|
+
*/
|
|
1224
|
+
export interface EMIOffer {
|
|
1225
|
+
/**
|
|
1226
|
+
* Type of emi offer. Possible values are `credit_card_emi`, `debit_card_emi`, `cardless_emi`
|
|
1227
|
+
* @type {string}
|
|
1228
|
+
* @memberof EMIOffer
|
|
1229
|
+
*/
|
|
1230
|
+
'type': string;
|
|
1231
|
+
/**
|
|
1232
|
+
* Bank Name
|
|
1233
|
+
* @type {string}
|
|
1234
|
+
* @memberof EMIOffer
|
|
1235
|
+
*/
|
|
1236
|
+
'issuer': string;
|
|
1237
|
+
/**
|
|
1238
|
+
*
|
|
1239
|
+
* @type {Array<number>}
|
|
1240
|
+
* @memberof EMIOffer
|
|
1241
|
+
*/
|
|
1242
|
+
'tenures': Array<number>;
|
|
1243
|
+
}
|
|
1244
|
+
/**
|
|
1245
|
+
* Single EMI object
|
|
1246
|
+
* @export
|
|
1247
|
+
* @interface EMIPlansArray
|
|
1248
|
+
*/
|
|
1249
|
+
export interface EMIPlansArray {
|
|
1250
|
+
/**
|
|
1251
|
+
*
|
|
1252
|
+
* @type {number}
|
|
1253
|
+
* @memberof EMIPlansArray
|
|
1254
|
+
*/
|
|
1255
|
+
'tenure'?: number;
|
|
1256
|
+
/**
|
|
1257
|
+
*
|
|
1258
|
+
* @type {number}
|
|
1259
|
+
* @memberof EMIPlansArray
|
|
1260
|
+
*/
|
|
1261
|
+
'interest_rate'?: number;
|
|
1262
|
+
/**
|
|
1263
|
+
*
|
|
1264
|
+
* @type {string}
|
|
1265
|
+
* @memberof EMIPlansArray
|
|
1266
|
+
*/
|
|
1267
|
+
'currency'?: string;
|
|
1268
|
+
/**
|
|
1269
|
+
*
|
|
1270
|
+
* @type {number}
|
|
1271
|
+
* @memberof EMIPlansArray
|
|
1272
|
+
*/
|
|
1273
|
+
'emi'?: number;
|
|
1274
|
+
/**
|
|
1275
|
+
*
|
|
1276
|
+
* @type {number}
|
|
1277
|
+
* @memberof EMIPlansArray
|
|
1278
|
+
*/
|
|
1279
|
+
'total_interest'?: number;
|
|
1280
|
+
/**
|
|
1281
|
+
*
|
|
1282
|
+
* @type {number}
|
|
1283
|
+
* @memberof EMIPlansArray
|
|
1284
|
+
*/
|
|
1285
|
+
'total_amount'?: number;
|
|
1286
|
+
}
|
|
1287
|
+
/**
|
|
1288
|
+
* Carless EMI eligible entity
|
|
1289
|
+
* @export
|
|
1290
|
+
* @interface EligibilityCardlessEMIEntity
|
|
1291
|
+
*/
|
|
1292
|
+
export interface EligibilityCardlessEMIEntity {
|
|
1293
|
+
/**
|
|
1294
|
+
*
|
|
1295
|
+
* @type {boolean}
|
|
1296
|
+
* @memberof EligibilityCardlessEMIEntity
|
|
1297
|
+
*/
|
|
1298
|
+
'eligibility'?: boolean;
|
|
1299
|
+
/**
|
|
1300
|
+
*
|
|
1301
|
+
* @type {string}
|
|
1302
|
+
* @memberof EligibilityCardlessEMIEntity
|
|
1303
|
+
*/
|
|
1304
|
+
'entity_type'?: string;
|
|
1305
|
+
/**
|
|
1306
|
+
*
|
|
1307
|
+
* @type {string}
|
|
1308
|
+
* @memberof EligibilityCardlessEMIEntity
|
|
1309
|
+
*/
|
|
1310
|
+
'entity_value'?: string;
|
|
1311
|
+
/**
|
|
1312
|
+
*
|
|
1313
|
+
* @type {CardlessEMIEntity}
|
|
1314
|
+
* @memberof EligibilityCardlessEMIEntity
|
|
1315
|
+
*/
|
|
1316
|
+
'entity_details'?: CardlessEMIEntity;
|
|
1317
|
+
}
|
|
1318
|
+
/**
|
|
1319
|
+
* eligibilty request for cardless
|
|
1320
|
+
* @export
|
|
1321
|
+
* @interface EligibilityFetchCardlessEMIRequest
|
|
1322
|
+
*/
|
|
1323
|
+
export interface EligibilityFetchCardlessEMIRequest {
|
|
1324
|
+
/**
|
|
1325
|
+
*
|
|
1326
|
+
* @type {CardlessEMIQueries}
|
|
1327
|
+
* @memberof EligibilityFetchCardlessEMIRequest
|
|
1328
|
+
*/
|
|
1329
|
+
'queries': CardlessEMIQueries;
|
|
1330
|
+
}
|
|
1331
|
+
/**
|
|
1332
|
+
* Eligiblty API request
|
|
1333
|
+
* @export
|
|
1334
|
+
* @interface EligibilityFetchOffersRequest
|
|
1335
|
+
*/
|
|
1336
|
+
export interface EligibilityFetchOffersRequest {
|
|
1337
|
+
/**
|
|
1338
|
+
*
|
|
1339
|
+
* @type {OfferQueries}
|
|
1340
|
+
* @memberof EligibilityFetchOffersRequest
|
|
1341
|
+
*/
|
|
1342
|
+
'queries': OfferQueries;
|
|
1343
|
+
/**
|
|
1344
|
+
*
|
|
1345
|
+
* @type {OfferFilters}
|
|
1346
|
+
* @memberof EligibilityFetchOffersRequest
|
|
1347
|
+
*/
|
|
1348
|
+
'filters'?: OfferFilters;
|
|
1349
|
+
}
|
|
1350
|
+
/**
|
|
1351
|
+
* Request to get eligible paylater payment methods
|
|
1352
|
+
* @export
|
|
1353
|
+
* @interface EligibilityFetchPaylaterRequest
|
|
1354
|
+
*/
|
|
1355
|
+
export interface EligibilityFetchPaylaterRequest {
|
|
1356
|
+
/**
|
|
1357
|
+
*
|
|
1358
|
+
* @type {CardlessEMIQueries}
|
|
1359
|
+
* @memberof EligibilityFetchPaylaterRequest
|
|
1360
|
+
*/
|
|
1361
|
+
'queries': CardlessEMIQueries;
|
|
1362
|
+
}
|
|
1363
|
+
/**
|
|
1364
|
+
* eligibilty request to find eligible payment method
|
|
1365
|
+
* @export
|
|
1366
|
+
* @interface EligibilityFetchPaymentMethodsRequest
|
|
1367
|
+
*/
|
|
1368
|
+
export interface EligibilityFetchPaymentMethodsRequest {
|
|
1369
|
+
/**
|
|
1370
|
+
*
|
|
1371
|
+
* @type {PaymentMethodsQueries}
|
|
1372
|
+
* @memberof EligibilityFetchPaymentMethodsRequest
|
|
1373
|
+
*/
|
|
1374
|
+
'queries': PaymentMethodsQueries;
|
|
1375
|
+
/**
|
|
1376
|
+
*
|
|
1377
|
+
* @type {PaymentMethodsFilters}
|
|
1378
|
+
* @memberof EligibilityFetchPaymentMethodsRequest
|
|
1379
|
+
*/
|
|
1380
|
+
'filters'?: PaymentMethodsFilters;
|
|
1381
|
+
}
|
|
1382
|
+
/**
|
|
1383
|
+
* Eligible offer object
|
|
1384
|
+
* @export
|
|
1385
|
+
* @interface EligibilityOfferEntity
|
|
1386
|
+
*/
|
|
1387
|
+
export interface EligibilityOfferEntity {
|
|
1388
|
+
/**
|
|
1389
|
+
*
|
|
1390
|
+
* @type {boolean}
|
|
1391
|
+
* @memberof EligibilityOfferEntity
|
|
1392
|
+
*/
|
|
1393
|
+
'eligibility'?: boolean;
|
|
1394
|
+
/**
|
|
1395
|
+
*
|
|
1396
|
+
* @type {string}
|
|
1397
|
+
* @memberof EligibilityOfferEntity
|
|
1398
|
+
*/
|
|
1399
|
+
'entity_type'?: string;
|
|
1400
|
+
/**
|
|
1401
|
+
*
|
|
1402
|
+
* @type {string}
|
|
1403
|
+
* @memberof EligibilityOfferEntity
|
|
1404
|
+
*/
|
|
1405
|
+
'entity_value'?: string;
|
|
1406
|
+
/**
|
|
1407
|
+
*
|
|
1408
|
+
* @type {OfferEntity}
|
|
1409
|
+
* @memberof EligibilityOfferEntity
|
|
1410
|
+
*/
|
|
1411
|
+
'entity_details'?: OfferEntity;
|
|
1412
|
+
}
|
|
1413
|
+
/**
|
|
1414
|
+
* Eligible paylater payment method
|
|
1415
|
+
* @export
|
|
1416
|
+
* @interface EligibilityPaylaterEntity
|
|
1417
|
+
*/
|
|
1418
|
+
export interface EligibilityPaylaterEntity {
|
|
1419
|
+
/**
|
|
1420
|
+
*
|
|
1421
|
+
* @type {boolean}
|
|
1422
|
+
* @memberof EligibilityPaylaterEntity
|
|
1423
|
+
*/
|
|
1424
|
+
'eligibility'?: boolean;
|
|
1425
|
+
/**
|
|
1426
|
+
*
|
|
1427
|
+
* @type {string}
|
|
1428
|
+
* @memberof EligibilityPaylaterEntity
|
|
1429
|
+
*/
|
|
1430
|
+
'entity_type'?: string;
|
|
1431
|
+
/**
|
|
1432
|
+
*
|
|
1433
|
+
* @type {string}
|
|
1434
|
+
* @memberof EligibilityPaylaterEntity
|
|
1435
|
+
*/
|
|
1436
|
+
'entity_value'?: string;
|
|
1437
|
+
/**
|
|
1438
|
+
*
|
|
1439
|
+
* @type {PaylaterEntity}
|
|
1440
|
+
* @memberof EligibilityPaylaterEntity
|
|
1441
|
+
*/
|
|
1442
|
+
'entity_details'?: PaylaterEntity;
|
|
1443
|
+
}
|
|
1444
|
+
/**
|
|
1445
|
+
* Eligible payment methods details
|
|
1446
|
+
* @export
|
|
1447
|
+
* @interface EligibilityPaymentMethodsEntity
|
|
1448
|
+
*/
|
|
1449
|
+
export interface EligibilityPaymentMethodsEntity {
|
|
1450
|
+
/**
|
|
1451
|
+
*
|
|
1452
|
+
* @type {boolean}
|
|
1453
|
+
* @memberof EligibilityPaymentMethodsEntity
|
|
1454
|
+
*/
|
|
1455
|
+
'eligibility'?: boolean;
|
|
1456
|
+
/**
|
|
1457
|
+
*
|
|
1458
|
+
* @type {string}
|
|
1459
|
+
* @memberof EligibilityPaymentMethodsEntity
|
|
1460
|
+
*/
|
|
1461
|
+
'entity_type'?: string;
|
|
1462
|
+
/**
|
|
1463
|
+
*
|
|
1464
|
+
* @type {string}
|
|
1465
|
+
* @memberof EligibilityPaymentMethodsEntity
|
|
1466
|
+
*/
|
|
1467
|
+
'entity_value'?: string;
|
|
1468
|
+
/**
|
|
1469
|
+
*
|
|
1470
|
+
* @type {EligibilityPaymentMethodsEntityEntityDetails}
|
|
1471
|
+
* @memberof EligibilityPaymentMethodsEntity
|
|
1472
|
+
*/
|
|
1473
|
+
'entity_details'?: EligibilityPaymentMethodsEntityEntityDetails;
|
|
1474
|
+
}
|
|
1475
|
+
/**
|
|
1476
|
+
*
|
|
1477
|
+
* @export
|
|
1478
|
+
* @interface EligibilityPaymentMethodsEntityEntityDetails
|
|
1479
|
+
*/
|
|
1480
|
+
export interface EligibilityPaymentMethodsEntityEntityDetails {
|
|
1481
|
+
/**
|
|
1482
|
+
*
|
|
1483
|
+
* @type {Array<PaymentModeDetails>}
|
|
1484
|
+
* @memberof EligibilityPaymentMethodsEntityEntityDetails
|
|
1485
|
+
*/
|
|
1486
|
+
'payment_method_details'?: Array<PaymentModeDetails>;
|
|
1487
|
+
}
|
|
1488
|
+
/**
|
|
1489
|
+
* The error details are present only for failed payments
|
|
1490
|
+
* @export
|
|
1491
|
+
* @interface ErrorDetailsInPaymentsEntity
|
|
1492
|
+
*/
|
|
1493
|
+
export interface ErrorDetailsInPaymentsEntity {
|
|
1494
|
+
/**
|
|
1495
|
+
*
|
|
1496
|
+
* @type {string}
|
|
1497
|
+
* @memberof ErrorDetailsInPaymentsEntity
|
|
1498
|
+
*/
|
|
1499
|
+
'error_code'?: string;
|
|
1500
|
+
/**
|
|
1501
|
+
*
|
|
1502
|
+
* @type {string}
|
|
1503
|
+
* @memberof ErrorDetailsInPaymentsEntity
|
|
1504
|
+
*/
|
|
1505
|
+
'error_description'?: string;
|
|
1506
|
+
/**
|
|
1507
|
+
*
|
|
1508
|
+
* @type {string}
|
|
1509
|
+
* @memberof ErrorDetailsInPaymentsEntity
|
|
1510
|
+
*/
|
|
1511
|
+
'error_reason'?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
*
|
|
1514
|
+
* @type {string}
|
|
1515
|
+
* @memberof ErrorDetailsInPaymentsEntity
|
|
1516
|
+
*/
|
|
1517
|
+
'error_source'?: string;
|
|
1518
|
+
/**
|
|
1519
|
+
*
|
|
1520
|
+
* @type {string}
|
|
1521
|
+
* @memberof ErrorDetailsInPaymentsEntity
|
|
1522
|
+
*/
|
|
1523
|
+
'error_code_raw'?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
*
|
|
1526
|
+
* @type {string}
|
|
1527
|
+
* @memberof ErrorDetailsInPaymentsEntity
|
|
1528
|
+
*/
|
|
1529
|
+
'error_description_raw'?: string;
|
|
1530
|
+
/**
|
|
1531
|
+
*
|
|
1532
|
+
* @type {string}
|
|
1533
|
+
* @memberof ErrorDetailsInPaymentsEntity
|
|
1534
|
+
*/
|
|
1535
|
+
'error_subcode_raw'?: string;
|
|
1536
|
+
}
|
|
1537
|
+
/**
|
|
1538
|
+
* Recon object
|
|
1539
|
+
* @export
|
|
1540
|
+
* @interface FetchReconRequest
|
|
1541
|
+
*/
|
|
1542
|
+
export interface FetchReconRequest {
|
|
1543
|
+
/**
|
|
1544
|
+
*
|
|
1545
|
+
* @type {FetchReconRequestPagination}
|
|
1546
|
+
* @memberof FetchReconRequest
|
|
1547
|
+
*/
|
|
1548
|
+
'pagination': FetchReconRequestPagination;
|
|
1549
|
+
/**
|
|
1550
|
+
*
|
|
1551
|
+
* @type {FetchReconRequestFilters}
|
|
1552
|
+
* @memberof FetchReconRequest
|
|
1553
|
+
*/
|
|
1554
|
+
'filters': FetchReconRequestFilters;
|
|
1555
|
+
}
|
|
1556
|
+
/**
|
|
1557
|
+
*
|
|
1558
|
+
* @export
|
|
1559
|
+
* @interface FetchReconRequestFilters
|
|
1560
|
+
*/
|
|
1561
|
+
export interface FetchReconRequestFilters {
|
|
1562
|
+
/**
|
|
1563
|
+
* Specify the start date from when you want the settlement reconciliation details.
|
|
1564
|
+
* @type {string}
|
|
1565
|
+
* @memberof FetchReconRequestFilters
|
|
1566
|
+
*/
|
|
1567
|
+
'start_date': string;
|
|
1568
|
+
/**
|
|
1569
|
+
* Specify the end date till when you want the settlement reconciliation details.
|
|
1570
|
+
* @type {string}
|
|
1571
|
+
* @memberof FetchReconRequestFilters
|
|
1572
|
+
*/
|
|
1573
|
+
'end_date': string;
|
|
1574
|
+
}
|
|
1575
|
+
/**
|
|
1576
|
+
* To fetch the next set of settlements, pass the cursor received in the response to the next API call. To receive the data for the first time, pass the cursor as null. Limit would be number of settlements that you want to receive.
|
|
1577
|
+
* @export
|
|
1578
|
+
* @interface FetchReconRequestPagination
|
|
1579
|
+
*/
|
|
1580
|
+
export interface FetchReconRequestPagination {
|
|
1581
|
+
/**
|
|
1582
|
+
* Number of settlements you want to fetch in the next iteration. Maximum limit is 1000, default value is 10.
|
|
1583
|
+
* @type {number}
|
|
1584
|
+
* @memberof FetchReconRequestPagination
|
|
1585
|
+
*/
|
|
1586
|
+
'limit': number;
|
|
1587
|
+
/**
|
|
1588
|
+
* Specifies from where the next set of settlement details should be fetched.
|
|
1589
|
+
* @type {string}
|
|
1590
|
+
* @memberof FetchReconRequestPagination
|
|
1591
|
+
*/
|
|
1592
|
+
'cursor'?: string | null;
|
|
1593
|
+
}
|
|
1594
|
+
/**
|
|
1595
|
+
* Request to fetch settlement
|
|
1596
|
+
* @export
|
|
1597
|
+
* @interface FetchSettlementsRequest
|
|
1598
|
+
*/
|
|
1599
|
+
export interface FetchSettlementsRequest {
|
|
1600
|
+
/**
|
|
1601
|
+
*
|
|
1602
|
+
* @type {FetchSettlementsRequestPagination}
|
|
1603
|
+
* @memberof FetchSettlementsRequest
|
|
1604
|
+
*/
|
|
1605
|
+
'pagination': FetchSettlementsRequestPagination;
|
|
1606
|
+
/**
|
|
1607
|
+
*
|
|
1608
|
+
* @type {FetchSettlementsRequestFilters}
|
|
1609
|
+
* @memberof FetchSettlementsRequest
|
|
1610
|
+
*/
|
|
1611
|
+
'filters': FetchSettlementsRequestFilters;
|
|
1612
|
+
}
|
|
1613
|
+
/**
|
|
1614
|
+
* Specify either the Settlement ID, Settlement UTR, or start date and end date to fetch the settlement details.
|
|
1615
|
+
* @export
|
|
1616
|
+
* @interface FetchSettlementsRequestFilters
|
|
1617
|
+
*/
|
|
1618
|
+
export interface FetchSettlementsRequestFilters {
|
|
1619
|
+
/**
|
|
1620
|
+
* List of settlement IDs for which you want the settlement reconciliation details.
|
|
1621
|
+
* @type {Array<number>}
|
|
1622
|
+
* @memberof FetchSettlementsRequestFilters
|
|
1623
|
+
*/
|
|
1624
|
+
'cf_settlement_ids'?: Array<number>;
|
|
1625
|
+
/**
|
|
1626
|
+
* List of settlement UTRs for which you want the settlement reconciliation details.
|
|
1627
|
+
* @type {Array<string>}
|
|
1628
|
+
* @memberof FetchSettlementsRequestFilters
|
|
1629
|
+
*/
|
|
1630
|
+
'settlement_utrs'?: Array<string>;
|
|
1631
|
+
/**
|
|
1632
|
+
* Specify the start date from when you want the settlement reconciliation details.
|
|
1633
|
+
* @type {string}
|
|
1634
|
+
* @memberof FetchSettlementsRequestFilters
|
|
1635
|
+
*/
|
|
1636
|
+
'start_date'?: string;
|
|
1637
|
+
/**
|
|
1638
|
+
* Specify the end date till when you want the settlement reconciliation details.
|
|
1639
|
+
* @type {string}
|
|
1640
|
+
* @memberof FetchSettlementsRequestFilters
|
|
1641
|
+
*/
|
|
1642
|
+
'end_date'?: string;
|
|
1643
|
+
}
|
|
1644
|
+
/**
|
|
1645
|
+
* To fetch the next set of settlements, pass the cursor received in the response to the next API call. To receive the data for the first time, pass the cursor as null. Limit would be number of settlements that you want to receive.
|
|
1646
|
+
* @export
|
|
1647
|
+
* @interface FetchSettlementsRequestPagination
|
|
1648
|
+
*/
|
|
1649
|
+
export interface FetchSettlementsRequestPagination {
|
|
1650
|
+
/**
|
|
1651
|
+
* The number of settlements you want to fetch. Maximum limit is 1000, default value is 10.
|
|
1652
|
+
* @type {number}
|
|
1653
|
+
* @memberof FetchSettlementsRequestPagination
|
|
1654
|
+
*/
|
|
1655
|
+
'limit': number;
|
|
1656
|
+
/**
|
|
1657
|
+
* Specifies from where the next set of settlement details should be fetched.
|
|
1658
|
+
* @type {string}
|
|
1659
|
+
* @memberof FetchSettlementsRequestPagination
|
|
1660
|
+
*/
|
|
1661
|
+
'cursor'?: string;
|
|
1662
|
+
}
|
|
1663
|
+
/**
|
|
1664
|
+
* Fetch Static QR Codes using terminal ID or phone number
|
|
1665
|
+
* @export
|
|
1666
|
+
* @interface FetchTerminalQRCodesEntity
|
|
1667
|
+
*/
|
|
1668
|
+
export interface FetchTerminalQRCodesEntity {
|
|
1669
|
+
/**
|
|
1670
|
+
* Name of the bank that is linked to the Static QR.
|
|
1671
|
+
* @type {string}
|
|
1672
|
+
* @memberof FetchTerminalQRCodesEntity
|
|
1673
|
+
*/
|
|
1674
|
+
'bank'?: string;
|
|
1675
|
+
/**
|
|
1676
|
+
* Base-64 Encoded QR Code URL
|
|
1677
|
+
* @type {string}
|
|
1678
|
+
* @memberof FetchTerminalQRCodesEntity
|
|
1679
|
+
*/
|
|
1680
|
+
'qrCode'?: string;
|
|
1681
|
+
/**
|
|
1682
|
+
* URL of the qr Code.
|
|
1683
|
+
* @type {string}
|
|
1684
|
+
* @memberof FetchTerminalQRCodesEntity
|
|
1685
|
+
*/
|
|
1686
|
+
'qrCodeUrl'?: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* Status of the static QR.
|
|
1689
|
+
* @type {string}
|
|
1690
|
+
* @memberof FetchTerminalQRCodesEntity
|
|
1691
|
+
*/
|
|
1692
|
+
'status'?: string;
|
|
1693
|
+
}
|
|
1694
|
+
/**
|
|
1695
|
+
* Error when idempotency fails. Different request body with the same idempotent key
|
|
1696
|
+
* @export
|
|
1697
|
+
* @interface IdempotencyError
|
|
1698
|
+
*/
|
|
1699
|
+
export interface IdempotencyError {
|
|
1700
|
+
/**
|
|
1701
|
+
*
|
|
1702
|
+
* @type {string}
|
|
1703
|
+
* @memberof IdempotencyError
|
|
1704
|
+
*/
|
|
1705
|
+
'message'?: string;
|
|
1706
|
+
/**
|
|
1707
|
+
*
|
|
1708
|
+
* @type {string}
|
|
1709
|
+
* @memberof IdempotencyError
|
|
1710
|
+
*/
|
|
1711
|
+
'code'?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* idempotency_error
|
|
1714
|
+
* @type {string}
|
|
1715
|
+
* @memberof IdempotencyError
|
|
1716
|
+
*/
|
|
1717
|
+
'type'?: IdempotencyErrorTypeEnum;
|
|
1718
|
+
}
|
|
1719
|
+
export declare const IdempotencyErrorTypeEnum: {
|
|
1720
|
+
readonly IDEMPOTENCY_ERROR: "idempotency_error";
|
|
1721
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
1722
|
+
};
|
|
1723
|
+
export type IdempotencyErrorTypeEnum = typeof IdempotencyErrorTypeEnum[keyof typeof IdempotencyErrorTypeEnum];
|
|
1724
|
+
/**
|
|
1725
|
+
* Saved card instrument object
|
|
1726
|
+
* @export
|
|
1727
|
+
* @interface InstrumentEntity
|
|
1728
|
+
*/
|
|
1729
|
+
export interface InstrumentEntity {
|
|
1730
|
+
/**
|
|
1731
|
+
* customer_id for which the instrument was saved
|
|
1732
|
+
* @type {string}
|
|
1733
|
+
* @memberof InstrumentEntity
|
|
1734
|
+
*/
|
|
1735
|
+
'customer_id'?: string;
|
|
1736
|
+
/**
|
|
1737
|
+
* cf_payment_id of the successful transaction done while saving instrument
|
|
1738
|
+
* @type {string}
|
|
1739
|
+
* @memberof InstrumentEntity
|
|
1740
|
+
*/
|
|
1741
|
+
'afa_reference'?: string;
|
|
1742
|
+
/**
|
|
1743
|
+
* saved instrument id
|
|
1744
|
+
* @type {string}
|
|
1745
|
+
* @memberof InstrumentEntity
|
|
1746
|
+
*/
|
|
1747
|
+
'instrument_id'?: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* Type of the saved instrument
|
|
1750
|
+
* @type {string}
|
|
1751
|
+
* @memberof InstrumentEntity
|
|
1752
|
+
*/
|
|
1753
|
+
'instrument_type'?: InstrumentEntityInstrumentTypeEnum;
|
|
1754
|
+
/**
|
|
1755
|
+
* Unique id for the saved instrument
|
|
1756
|
+
* @type {string}
|
|
1757
|
+
* @memberof InstrumentEntity
|
|
1758
|
+
*/
|
|
1759
|
+
'instrument_uid'?: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* masked card number displayed to the customer
|
|
1762
|
+
* @type {string}
|
|
1763
|
+
* @memberof InstrumentEntity
|
|
1764
|
+
*/
|
|
1765
|
+
'instrument_display'?: string;
|
|
1766
|
+
/**
|
|
1767
|
+
* Status of the saved instrument.
|
|
1768
|
+
* @type {string}
|
|
1769
|
+
* @memberof InstrumentEntity
|
|
1770
|
+
*/
|
|
1771
|
+
'instrument_status'?: InstrumentEntityInstrumentStatusEnum;
|
|
1772
|
+
/**
|
|
1773
|
+
* Timestamp at which instrument was saved.
|
|
1774
|
+
* @type {string}
|
|
1775
|
+
* @memberof InstrumentEntity
|
|
1776
|
+
*/
|
|
1777
|
+
'created_at'?: string;
|
|
1778
|
+
/**
|
|
1779
|
+
*
|
|
1780
|
+
* @type {SavedInstrumentMeta}
|
|
1781
|
+
* @memberof InstrumentEntity
|
|
1782
|
+
*/
|
|
1783
|
+
'instrument_meta'?: SavedInstrumentMeta;
|
|
1784
|
+
}
|
|
1785
|
+
export declare const InstrumentEntityInstrumentTypeEnum: {
|
|
1786
|
+
readonly CARD: "card";
|
|
1787
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
1788
|
+
};
|
|
1789
|
+
export type InstrumentEntityInstrumentTypeEnum = typeof InstrumentEntityInstrumentTypeEnum[keyof typeof InstrumentEntityInstrumentTypeEnum];
|
|
1790
|
+
export declare const InstrumentEntityInstrumentStatusEnum: {
|
|
1791
|
+
readonly ACTIVE: "ACTIVE";
|
|
1792
|
+
readonly INACTIVE: "INACTIVE";
|
|
1793
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
1794
|
+
};
|
|
1795
|
+
export type InstrumentEntityInstrumentStatusEnum = typeof InstrumentEntityInstrumentStatusEnum[keyof typeof InstrumentEntityInstrumentStatusEnum];
|
|
1796
|
+
/**
|
|
1797
|
+
* Payment link customer entity
|
|
1798
|
+
* @export
|
|
1799
|
+
* @interface LinkCustomerDetailsEntity
|
|
1800
|
+
*/
|
|
1801
|
+
export interface LinkCustomerDetailsEntity {
|
|
1802
|
+
/**
|
|
1803
|
+
* Customer phone number
|
|
1804
|
+
* @type {string}
|
|
1805
|
+
* @memberof LinkCustomerDetailsEntity
|
|
1806
|
+
*/
|
|
1807
|
+
'customer_phone': string;
|
|
1808
|
+
/**
|
|
1809
|
+
* Customer email address
|
|
1810
|
+
* @type {string}
|
|
1811
|
+
* @memberof LinkCustomerDetailsEntity
|
|
1812
|
+
*/
|
|
1813
|
+
'customer_email'?: string;
|
|
1814
|
+
/**
|
|
1815
|
+
* Customer name
|
|
1816
|
+
* @type {string}
|
|
1817
|
+
* @memberof LinkCustomerDetailsEntity
|
|
1818
|
+
*/
|
|
1819
|
+
'customer_name'?: string;
|
|
1820
|
+
}
|
|
1821
|
+
/**
|
|
1822
|
+
* Payment link success creation response object
|
|
1823
|
+
* @export
|
|
1824
|
+
* @interface LinkEntity
|
|
1825
|
+
*/
|
|
1826
|
+
export interface LinkEntity {
|
|
1827
|
+
/**
|
|
1828
|
+
*
|
|
1829
|
+
* @type {number}
|
|
1830
|
+
* @memberof LinkEntity
|
|
1831
|
+
*/
|
|
1832
|
+
'cf_link_id'?: number;
|
|
1833
|
+
/**
|
|
1834
|
+
*
|
|
1835
|
+
* @type {string}
|
|
1836
|
+
* @memberof LinkEntity
|
|
1837
|
+
*/
|
|
1838
|
+
'link_id'?: string;
|
|
1839
|
+
/**
|
|
1840
|
+
*
|
|
1841
|
+
* @type {string}
|
|
1842
|
+
* @memberof LinkEntity
|
|
1843
|
+
*/
|
|
1844
|
+
'link_status'?: string;
|
|
1845
|
+
/**
|
|
1846
|
+
*
|
|
1847
|
+
* @type {string}
|
|
1848
|
+
* @memberof LinkEntity
|
|
1849
|
+
*/
|
|
1850
|
+
'link_currency'?: string;
|
|
1851
|
+
/**
|
|
1852
|
+
*
|
|
1853
|
+
* @type {number}
|
|
1854
|
+
* @memberof LinkEntity
|
|
1855
|
+
*/
|
|
1856
|
+
'link_amount'?: number;
|
|
1857
|
+
/**
|
|
1858
|
+
*
|
|
1859
|
+
* @type {number}
|
|
1860
|
+
* @memberof LinkEntity
|
|
1861
|
+
*/
|
|
1862
|
+
'link_amount_paid'?: number;
|
|
1863
|
+
/**
|
|
1864
|
+
*
|
|
1865
|
+
* @type {boolean}
|
|
1866
|
+
* @memberof LinkEntity
|
|
1867
|
+
*/
|
|
1868
|
+
'link_partial_payments'?: boolean;
|
|
1869
|
+
/**
|
|
1870
|
+
*
|
|
1871
|
+
* @type {number}
|
|
1872
|
+
* @memberof LinkEntity
|
|
1873
|
+
*/
|
|
1874
|
+
'link_minimum_partial_amount'?: number;
|
|
1875
|
+
/**
|
|
1876
|
+
*
|
|
1877
|
+
* @type {string}
|
|
1878
|
+
* @memberof LinkEntity
|
|
1879
|
+
*/
|
|
1880
|
+
'link_purpose'?: string;
|
|
1881
|
+
/**
|
|
1882
|
+
*
|
|
1883
|
+
* @type {string}
|
|
1884
|
+
* @memberof LinkEntity
|
|
1885
|
+
*/
|
|
1886
|
+
'link_created_at'?: string;
|
|
1887
|
+
/**
|
|
1888
|
+
*
|
|
1889
|
+
* @type {LinkCustomerDetailsEntity}
|
|
1890
|
+
* @memberof LinkEntity
|
|
1891
|
+
*/
|
|
1892
|
+
'customer_details'?: LinkCustomerDetailsEntity;
|
|
1893
|
+
/**
|
|
1894
|
+
*
|
|
1895
|
+
* @type {LinkMetaEntity}
|
|
1896
|
+
* @memberof LinkEntity
|
|
1897
|
+
*/
|
|
1898
|
+
'link_meta'?: LinkMetaEntity;
|
|
1899
|
+
/**
|
|
1900
|
+
*
|
|
1901
|
+
* @type {string}
|
|
1902
|
+
* @memberof LinkEntity
|
|
1903
|
+
*/
|
|
1904
|
+
'link_url'?: string;
|
|
1905
|
+
/**
|
|
1906
|
+
*
|
|
1907
|
+
* @type {string}
|
|
1908
|
+
* @memberof LinkEntity
|
|
1909
|
+
*/
|
|
1910
|
+
'link_expiry_time'?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs
|
|
1913
|
+
* @type {{ [key: string]: string; }}
|
|
1914
|
+
* @memberof LinkEntity
|
|
1915
|
+
*/
|
|
1916
|
+
'link_notes'?: {
|
|
1917
|
+
[key: string]: string;
|
|
1918
|
+
};
|
|
1919
|
+
/**
|
|
1920
|
+
*
|
|
1921
|
+
* @type {boolean}
|
|
1922
|
+
* @memberof LinkEntity
|
|
1923
|
+
*/
|
|
1924
|
+
'link_auto_reminders'?: boolean;
|
|
1925
|
+
/**
|
|
1926
|
+
*
|
|
1927
|
+
* @type {LinkNotifyEntity}
|
|
1928
|
+
* @memberof LinkEntity
|
|
1929
|
+
*/
|
|
1930
|
+
'link_notify'?: LinkNotifyEntity;
|
|
1931
|
+
}
|
|
1932
|
+
/**
|
|
1933
|
+
* Payment link meta information object
|
|
1934
|
+
* @export
|
|
1935
|
+
* @interface LinkMetaEntity
|
|
1936
|
+
*/
|
|
1937
|
+
export interface LinkMetaEntity {
|
|
1938
|
+
/**
|
|
1939
|
+
* Notification URL for server-server communication. It should be an https URL.
|
|
1940
|
+
* @type {string}
|
|
1941
|
+
* @memberof LinkMetaEntity
|
|
1942
|
+
*/
|
|
1943
|
+
'notify_url'?: string;
|
|
1944
|
+
/**
|
|
1945
|
+
* If \"true\", link will directly open UPI Intent flow on mobile, and normal link flow elsewhere
|
|
1946
|
+
* @type {boolean}
|
|
1947
|
+
* @memberof LinkMetaEntity
|
|
1948
|
+
*/
|
|
1949
|
+
'upi_intent'?: boolean;
|
|
1950
|
+
/**
|
|
1951
|
+
* The URL to which user will be redirected to after the payment is done on the link. Maximum length: 250.
|
|
1952
|
+
* @type {string}
|
|
1953
|
+
* @memberof LinkMetaEntity
|
|
1954
|
+
*/
|
|
1955
|
+
'return_url'?: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* Allowed payment modes for this link. Pass comma-separated values among following options - \"cc\", \"dc\", \"ccc\", \"ppc\", \"nb\", \"upi\", \"paypal\", \"app\". Leave it blank to show all available payment methods
|
|
1958
|
+
* @type {string}
|
|
1959
|
+
* @memberof LinkMetaEntity
|
|
1960
|
+
*/
|
|
1961
|
+
'payment_methods'?: string;
|
|
1962
|
+
}
|
|
1963
|
+
/**
|
|
1964
|
+
* Payment link Notify Object for SMS and Email
|
|
1965
|
+
* @export
|
|
1966
|
+
* @interface LinkNotifyEntity
|
|
1967
|
+
*/
|
|
1968
|
+
export interface LinkNotifyEntity {
|
|
1969
|
+
/**
|
|
1970
|
+
* If \"true\", Cashfree will send sms on customer_phone
|
|
1971
|
+
* @type {boolean}
|
|
1972
|
+
* @memberof LinkNotifyEntity
|
|
1973
|
+
*/
|
|
1974
|
+
'send_sms'?: boolean;
|
|
1975
|
+
/**
|
|
1976
|
+
* If \"true\", Cashfree will send email on customer_email
|
|
1977
|
+
* @type {boolean}
|
|
1978
|
+
* @memberof LinkNotifyEntity
|
|
1979
|
+
*/
|
|
1980
|
+
'send_email'?: boolean;
|
|
1981
|
+
}
|
|
1982
|
+
/**
|
|
1983
|
+
* Payment method for netbanking object
|
|
1984
|
+
* @export
|
|
1985
|
+
* @interface NetBankingPaymentMethod
|
|
1986
|
+
*/
|
|
1987
|
+
export interface NetBankingPaymentMethod {
|
|
1988
|
+
/**
|
|
1989
|
+
*
|
|
1990
|
+
* @type {Netbanking}
|
|
1991
|
+
* @memberof NetBankingPaymentMethod
|
|
1992
|
+
*/
|
|
1993
|
+
'netbanking': Netbanking | null;
|
|
1994
|
+
}
|
|
1995
|
+
/**
|
|
1996
|
+
* Netbanking payment method request body
|
|
1997
|
+
* @export
|
|
1998
|
+
* @interface Netbanking
|
|
1999
|
+
*/
|
|
2000
|
+
export interface Netbanking {
|
|
2001
|
+
/**
|
|
2002
|
+
* The channel for netbanking will always be `link`
|
|
2003
|
+
* @type {string}
|
|
2004
|
+
* @memberof Netbanking
|
|
2005
|
+
*/
|
|
2006
|
+
'channel': string;
|
|
2007
|
+
/**
|
|
2008
|
+
* Bank code
|
|
2009
|
+
* @type {number}
|
|
2010
|
+
* @memberof Netbanking
|
|
2011
|
+
*/
|
|
2012
|
+
'netbanking_bank_code'?: number;
|
|
2013
|
+
/**
|
|
2014
|
+
* String code for bank
|
|
2015
|
+
* @type {string}
|
|
2016
|
+
* @memberof Netbanking
|
|
2017
|
+
*/
|
|
2018
|
+
'netbanking_bank_name'?: string;
|
|
2019
|
+
}
|
|
2020
|
+
/**
|
|
2021
|
+
* returns all offers
|
|
2022
|
+
* @export
|
|
2023
|
+
* @interface OfferAll
|
|
2024
|
+
*/
|
|
2025
|
+
export interface OfferAll {
|
|
2026
|
+
/**
|
|
2027
|
+
* All offers applicable
|
|
2028
|
+
* @type {object}
|
|
2029
|
+
* @memberof OfferAll
|
|
2030
|
+
*/
|
|
2031
|
+
'all': object;
|
|
2032
|
+
}
|
|
2033
|
+
/**
|
|
2034
|
+
* Offers related to cards
|
|
2035
|
+
* @export
|
|
2036
|
+
* @interface OfferCard
|
|
2037
|
+
*/
|
|
2038
|
+
export interface OfferCard {
|
|
2039
|
+
/**
|
|
2040
|
+
*
|
|
2041
|
+
* @type {CardOffer}
|
|
2042
|
+
* @memberof OfferCard
|
|
2043
|
+
*/
|
|
2044
|
+
'card': CardOffer;
|
|
2045
|
+
}
|
|
2046
|
+
/**
|
|
2047
|
+
* Offer details and type
|
|
2048
|
+
* @export
|
|
2049
|
+
* @interface OfferDetails
|
|
2050
|
+
*/
|
|
2051
|
+
export interface OfferDetails {
|
|
2052
|
+
/**
|
|
2053
|
+
* Offer Type for the Offer.
|
|
2054
|
+
* @type {string}
|
|
2055
|
+
* @memberof OfferDetails
|
|
2056
|
+
*/
|
|
2057
|
+
'offer_type': OfferDetailsOfferTypeEnum;
|
|
2058
|
+
/**
|
|
2059
|
+
*
|
|
2060
|
+
* @type {DiscountDetails}
|
|
2061
|
+
* @memberof OfferDetails
|
|
2062
|
+
*/
|
|
2063
|
+
'discount_details'?: DiscountDetails;
|
|
2064
|
+
/**
|
|
2065
|
+
*
|
|
2066
|
+
* @type {CashbackDetails}
|
|
2067
|
+
* @memberof OfferDetails
|
|
2068
|
+
*/
|
|
2069
|
+
'cashback_details'?: CashbackDetails;
|
|
2070
|
+
}
|
|
2071
|
+
export declare const OfferDetailsOfferTypeEnum: {
|
|
2072
|
+
readonly DISCOUNT: "DISCOUNT";
|
|
2073
|
+
readonly CASHBACK: "CASHBACK";
|
|
2074
|
+
readonly DISCOUNT_AND_CASHBACK: "DISCOUNT_AND_CASHBACK";
|
|
2075
|
+
readonly NO_COST_EMI: "NO_COST_EMI";
|
|
2076
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2077
|
+
};
|
|
2078
|
+
export type OfferDetailsOfferTypeEnum = typeof OfferDetailsOfferTypeEnum[keyof typeof OfferDetailsOfferTypeEnum];
|
|
2079
|
+
/**
|
|
2080
|
+
* EMI offer object
|
|
2081
|
+
* @export
|
|
2082
|
+
* @interface OfferEMI
|
|
2083
|
+
*/
|
|
2084
|
+
export interface OfferEMI {
|
|
2085
|
+
/**
|
|
2086
|
+
*
|
|
2087
|
+
* @type {EMIOffer}
|
|
2088
|
+
* @memberof OfferEMI
|
|
2089
|
+
*/
|
|
2090
|
+
'emi': EMIOffer;
|
|
2091
|
+
}
|
|
2092
|
+
/**
|
|
2093
|
+
* Offer entity object
|
|
2094
|
+
* @export
|
|
2095
|
+
* @interface OfferEntity
|
|
2096
|
+
*/
|
|
2097
|
+
export interface OfferEntity {
|
|
2098
|
+
/**
|
|
2099
|
+
*
|
|
2100
|
+
* @type {string}
|
|
2101
|
+
* @memberof OfferEntity
|
|
2102
|
+
*/
|
|
2103
|
+
'offer_id'?: string;
|
|
2104
|
+
/**
|
|
2105
|
+
*
|
|
2106
|
+
* @type {string}
|
|
2107
|
+
* @memberof OfferEntity
|
|
2108
|
+
*/
|
|
2109
|
+
'offer_status'?: string;
|
|
2110
|
+
/**
|
|
2111
|
+
*
|
|
2112
|
+
* @type {OfferMeta}
|
|
2113
|
+
* @memberof OfferEntity
|
|
2114
|
+
*/
|
|
2115
|
+
'offer_meta'?: OfferMeta;
|
|
2116
|
+
/**
|
|
2117
|
+
*
|
|
2118
|
+
* @type {OfferTnc}
|
|
2119
|
+
* @memberof OfferEntity
|
|
2120
|
+
*/
|
|
2121
|
+
'offer_tnc'?: OfferTnc;
|
|
2122
|
+
/**
|
|
2123
|
+
*
|
|
2124
|
+
* @type {OfferDetails}
|
|
2125
|
+
* @memberof OfferEntity
|
|
2126
|
+
*/
|
|
2127
|
+
'offer_details'?: OfferDetails;
|
|
2128
|
+
/**
|
|
2129
|
+
*
|
|
2130
|
+
* @type {OfferValidations}
|
|
2131
|
+
* @memberof OfferEntity
|
|
2132
|
+
*/
|
|
2133
|
+
'offer_validations'?: OfferValidations;
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* Filter for offers
|
|
2137
|
+
* @export
|
|
2138
|
+
* @interface OfferFilters
|
|
2139
|
+
*/
|
|
2140
|
+
export interface OfferFilters {
|
|
2141
|
+
/**
|
|
2142
|
+
* Array of offer_type to be filtered.
|
|
2143
|
+
* @type {Array<OfferType>}
|
|
2144
|
+
* @memberof OfferFilters
|
|
2145
|
+
*/
|
|
2146
|
+
'offer_type'?: Array<OfferType>;
|
|
2147
|
+
}
|
|
2148
|
+
/**
|
|
2149
|
+
* Offer meta details object
|
|
2150
|
+
* @export
|
|
2151
|
+
* @interface OfferMeta
|
|
2152
|
+
*/
|
|
2153
|
+
export interface OfferMeta {
|
|
2154
|
+
/**
|
|
2155
|
+
* Title for the Offer.
|
|
2156
|
+
* @type {string}
|
|
2157
|
+
* @memberof OfferMeta
|
|
2158
|
+
*/
|
|
2159
|
+
'offer_title': string;
|
|
2160
|
+
/**
|
|
2161
|
+
* Description for the Offer.
|
|
2162
|
+
* @type {string}
|
|
2163
|
+
* @memberof OfferMeta
|
|
2164
|
+
*/
|
|
2165
|
+
'offer_description': string;
|
|
2166
|
+
/**
|
|
2167
|
+
* Unique identifier for the Offer.
|
|
2168
|
+
* @type {string}
|
|
2169
|
+
* @memberof OfferMeta
|
|
2170
|
+
*/
|
|
2171
|
+
'offer_code': string;
|
|
2172
|
+
/**
|
|
2173
|
+
* Start Time for the Offer
|
|
2174
|
+
* @type {string}
|
|
2175
|
+
* @memberof OfferMeta
|
|
2176
|
+
*/
|
|
2177
|
+
'offer_start_time': string;
|
|
2178
|
+
/**
|
|
2179
|
+
* Expiry Time for the Offer
|
|
2180
|
+
* @type {string}
|
|
2181
|
+
* @memberof OfferMeta
|
|
2182
|
+
*/
|
|
2183
|
+
'offer_end_time': string;
|
|
2184
|
+
}
|
|
2185
|
+
/**
|
|
2186
|
+
* Offer object ofr NetBanking
|
|
2187
|
+
* @export
|
|
2188
|
+
* @interface OfferNB
|
|
2189
|
+
*/
|
|
2190
|
+
export interface OfferNB {
|
|
2191
|
+
/**
|
|
2192
|
+
*
|
|
2193
|
+
* @type {OfferNBNetbanking}
|
|
2194
|
+
* @memberof OfferNB
|
|
2195
|
+
*/
|
|
2196
|
+
'netbanking': OfferNBNetbanking;
|
|
2197
|
+
}
|
|
2198
|
+
/**
|
|
2199
|
+
*
|
|
2200
|
+
* @export
|
|
2201
|
+
* @interface OfferNBNetbanking
|
|
2202
|
+
*/
|
|
2203
|
+
export interface OfferNBNetbanking {
|
|
2204
|
+
/**
|
|
2205
|
+
*
|
|
2206
|
+
* @type {string}
|
|
2207
|
+
* @memberof OfferNBNetbanking
|
|
2208
|
+
*/
|
|
2209
|
+
'bank_name'?: string;
|
|
2210
|
+
}
|
|
2211
|
+
/**
|
|
2212
|
+
* Offer object for paylater
|
|
2213
|
+
* @export
|
|
2214
|
+
* @interface OfferPaylater
|
|
2215
|
+
*/
|
|
2216
|
+
export interface OfferPaylater {
|
|
2217
|
+
/**
|
|
2218
|
+
*
|
|
2219
|
+
* @type {PaylaterOffer}
|
|
2220
|
+
* @memberof OfferPaylater
|
|
2221
|
+
*/
|
|
2222
|
+
'paylater': PaylaterOffer;
|
|
2223
|
+
}
|
|
2224
|
+
/**
|
|
2225
|
+
* Offer Query Object
|
|
2226
|
+
* @export
|
|
2227
|
+
* @interface OfferQueries
|
|
2228
|
+
*/
|
|
2229
|
+
export interface OfferQueries {
|
|
2230
|
+
/**
|
|
2231
|
+
* OrderId of the order. Either of `order_id` or `order_amount` is mandatory.
|
|
2232
|
+
* @type {string}
|
|
2233
|
+
* @memberof OfferQueries
|
|
2234
|
+
*/
|
|
2235
|
+
'order_id'?: string;
|
|
2236
|
+
/**
|
|
2237
|
+
* Amount of the order. OrderId of the order. Either of `order_id` or `order_amount` is mandatory.
|
|
2238
|
+
* @type {number}
|
|
2239
|
+
* @memberof OfferQueries
|
|
2240
|
+
*/
|
|
2241
|
+
'amount'?: number;
|
|
2242
|
+
}
|
|
2243
|
+
/**
|
|
2244
|
+
* Offer terms and condition object
|
|
2245
|
+
* @export
|
|
2246
|
+
* @interface OfferTnc
|
|
2247
|
+
*/
|
|
2248
|
+
export interface OfferTnc {
|
|
2249
|
+
/**
|
|
2250
|
+
* TnC Type for the Offer. It can be either `text` or `link`
|
|
2251
|
+
* @type {string}
|
|
2252
|
+
* @memberof OfferTnc
|
|
2253
|
+
*/
|
|
2254
|
+
'offer_tnc_type': OfferTncOfferTncTypeEnum;
|
|
2255
|
+
/**
|
|
2256
|
+
* TnC for the Offer.
|
|
2257
|
+
* @type {string}
|
|
2258
|
+
* @memberof OfferTnc
|
|
2259
|
+
*/
|
|
2260
|
+
'offer_tnc_value': string;
|
|
2261
|
+
}
|
|
2262
|
+
export declare const OfferTncOfferTncTypeEnum: {
|
|
2263
|
+
readonly TEXT: "text";
|
|
2264
|
+
readonly LINK: "link";
|
|
2265
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2266
|
+
};
|
|
2267
|
+
export type OfferTncOfferTncTypeEnum = typeof OfferTncOfferTncTypeEnum[keyof typeof OfferTncOfferTncTypeEnum];
|
|
2268
|
+
/**
|
|
2269
|
+
* Offer Type Object
|
|
2270
|
+
* @export
|
|
2271
|
+
* @enum {string}
|
|
2272
|
+
*/
|
|
2273
|
+
export declare const OfferType: {
|
|
2274
|
+
readonly DISCOUNT: "DISCOUNT";
|
|
2275
|
+
readonly CASHBACK: "CASHBACK";
|
|
2276
|
+
readonly DISCOUNT_AND_CASHBACK: "DISCOUNT_AND_CASHBACK";
|
|
2277
|
+
readonly NO_COST_EMI: "NO_COST_EMI";
|
|
2278
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2279
|
+
};
|
|
2280
|
+
export type OfferType = typeof OfferType[keyof typeof OfferType];
|
|
2281
|
+
/**
|
|
2282
|
+
* Offer object for UPI
|
|
2283
|
+
* @export
|
|
2284
|
+
* @interface OfferUPI
|
|
2285
|
+
*/
|
|
2286
|
+
export interface OfferUPI {
|
|
2287
|
+
/**
|
|
2288
|
+
*
|
|
2289
|
+
* @type {object}
|
|
2290
|
+
* @memberof OfferUPI
|
|
2291
|
+
*/
|
|
2292
|
+
'upi': object;
|
|
2293
|
+
}
|
|
2294
|
+
/**
|
|
2295
|
+
* Offer validation object
|
|
2296
|
+
* @export
|
|
2297
|
+
* @interface OfferValidations
|
|
2298
|
+
*/
|
|
2299
|
+
export interface OfferValidations {
|
|
2300
|
+
/**
|
|
2301
|
+
* Minimum Amount for Offer to be Applicable
|
|
2302
|
+
* @type {number}
|
|
2303
|
+
* @memberof OfferValidations
|
|
2304
|
+
*/
|
|
2305
|
+
'min_amount'?: number;
|
|
2306
|
+
/**
|
|
2307
|
+
*
|
|
2308
|
+
* @type {OfferValidationsPaymentMethod}
|
|
2309
|
+
* @memberof OfferValidations
|
|
2310
|
+
*/
|
|
2311
|
+
'payment_method': OfferValidationsPaymentMethod;
|
|
2312
|
+
/**
|
|
2313
|
+
* Maximum amount of Offer that can be availed.
|
|
2314
|
+
* @type {number}
|
|
2315
|
+
* @memberof OfferValidations
|
|
2316
|
+
*/
|
|
2317
|
+
'max_allowed': number;
|
|
2318
|
+
}
|
|
2319
|
+
/**
|
|
2320
|
+
* @type OfferValidationsPaymentMethod
|
|
2321
|
+
* @export
|
|
2322
|
+
*/
|
|
2323
|
+
export type OfferValidationsPaymentMethod = OfferAll | OfferCard | OfferEMI | OfferNB | OfferPaylater | OfferUPI | OfferWallet;
|
|
2324
|
+
/**
|
|
2325
|
+
* Offer object for wallet payment method
|
|
2326
|
+
* @export
|
|
2327
|
+
* @interface OfferWallet
|
|
2328
|
+
*/
|
|
2329
|
+
export interface OfferWallet {
|
|
2330
|
+
/**
|
|
2331
|
+
*
|
|
2332
|
+
* @type {WalletOffer}
|
|
2333
|
+
* @memberof OfferWallet
|
|
2334
|
+
*/
|
|
2335
|
+
'app'?: WalletOffer;
|
|
2336
|
+
}
|
|
2337
|
+
/**
|
|
2338
|
+
* This is the response shared when merchant inovkes the OTP submit or resend API
|
|
2339
|
+
* @export
|
|
2340
|
+
* @interface OrderAuthenticateEntity
|
|
2341
|
+
*/
|
|
2342
|
+
export interface OrderAuthenticateEntity {
|
|
2343
|
+
/**
|
|
2344
|
+
* The payment id for which this request was sent
|
|
2345
|
+
* @type {number}
|
|
2346
|
+
* @memberof OrderAuthenticateEntity
|
|
2347
|
+
*/
|
|
2348
|
+
'cf_payment_id'?: number;
|
|
2349
|
+
/**
|
|
2350
|
+
* The action that was invoked for this request.
|
|
2351
|
+
* @type {string}
|
|
2352
|
+
* @memberof OrderAuthenticateEntity
|
|
2353
|
+
*/
|
|
2354
|
+
'action'?: OrderAuthenticateEntityActionEnum;
|
|
2355
|
+
/**
|
|
2356
|
+
* Status of the is action. Will be either failed or successful. If the action is successful, you should still call the authorization status to verify the final payment status.
|
|
2357
|
+
* @type {string}
|
|
2358
|
+
* @memberof OrderAuthenticateEntity
|
|
2359
|
+
*/
|
|
2360
|
+
'authenticate_status'?: OrderAuthenticateEntityAuthenticateStatusEnum;
|
|
2361
|
+
/**
|
|
2362
|
+
* Human readable message which describes the status in more detail
|
|
2363
|
+
* @type {string}
|
|
2364
|
+
* @memberof OrderAuthenticateEntity
|
|
2365
|
+
*/
|
|
2366
|
+
'payment_message'?: string;
|
|
2367
|
+
}
|
|
2368
|
+
export declare const OrderAuthenticateEntityActionEnum: {
|
|
2369
|
+
readonly SUBMIT_OTP: "SUBMIT_OTP";
|
|
2370
|
+
readonly RESEND_OTP: "RESEND_OTP";
|
|
2371
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2372
|
+
};
|
|
2373
|
+
export type OrderAuthenticateEntityActionEnum = typeof OrderAuthenticateEntityActionEnum[keyof typeof OrderAuthenticateEntityActionEnum];
|
|
2374
|
+
export declare const OrderAuthenticateEntityAuthenticateStatusEnum: {
|
|
2375
|
+
readonly FAILED: "FAILED";
|
|
2376
|
+
readonly SUCCESS: "SUCCESS";
|
|
2377
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2378
|
+
};
|
|
2379
|
+
export type OrderAuthenticateEntityAuthenticateStatusEnum = typeof OrderAuthenticateEntityAuthenticateStatusEnum[keyof typeof OrderAuthenticateEntityAuthenticateStatusEnum];
|
|
2380
|
+
/**
|
|
2381
|
+
* OTP to be submitted for headless/native OTP
|
|
2382
|
+
* @export
|
|
2383
|
+
* @interface OrderAuthenticatePaymentRequest
|
|
2384
|
+
*/
|
|
2385
|
+
export interface OrderAuthenticatePaymentRequest {
|
|
2386
|
+
/**
|
|
2387
|
+
* OTP to be submitted
|
|
2388
|
+
* @type {string}
|
|
2389
|
+
* @memberof OrderAuthenticatePaymentRequest
|
|
2390
|
+
*/
|
|
2391
|
+
'otp': string;
|
|
2392
|
+
/**
|
|
2393
|
+
* The action for this workflow. Could be either SUBMIT_OTP or RESEND_OTP
|
|
2394
|
+
* @type {string}
|
|
2395
|
+
* @memberof OrderAuthenticatePaymentRequest
|
|
2396
|
+
*/
|
|
2397
|
+
'action': OrderAuthenticatePaymentRequestActionEnum;
|
|
2398
|
+
}
|
|
2399
|
+
export declare const OrderAuthenticatePaymentRequestActionEnum: {
|
|
2400
|
+
readonly SUBMIT_OTP: "SUBMIT_OTP";
|
|
2401
|
+
readonly RESEND_OTP: "RESEND_OTP";
|
|
2402
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2403
|
+
};
|
|
2404
|
+
export type OrderAuthenticatePaymentRequestActionEnum = typeof OrderAuthenticatePaymentRequestActionEnum[keyof typeof OrderAuthenticatePaymentRequestActionEnum];
|
|
2405
|
+
/**
|
|
2406
|
+
* create refund request object
|
|
2407
|
+
* @export
|
|
2408
|
+
* @interface OrderCreateRefundRequest
|
|
2409
|
+
*/
|
|
2410
|
+
export interface OrderCreateRefundRequest {
|
|
2411
|
+
/**
|
|
2412
|
+
* Amount to be refunded. Should be lesser than or equal to the transaction amount. (Decimals allowed)
|
|
2413
|
+
* @type {number}
|
|
2414
|
+
* @memberof OrderCreateRefundRequest
|
|
2415
|
+
*/
|
|
2416
|
+
'refund_amount': number;
|
|
2417
|
+
/**
|
|
2418
|
+
* An unique ID to associate the refund with. Provie alphanumeric values
|
|
2419
|
+
* @type {string}
|
|
2420
|
+
* @memberof OrderCreateRefundRequest
|
|
2421
|
+
*/
|
|
2422
|
+
'refund_id': string;
|
|
2423
|
+
/**
|
|
2424
|
+
* A refund note for your reference.
|
|
2425
|
+
* @type {string}
|
|
2426
|
+
* @memberof OrderCreateRefundRequest
|
|
2427
|
+
*/
|
|
2428
|
+
'refund_note'?: string;
|
|
2429
|
+
/**
|
|
2430
|
+
* Speed at which the refund is processed. It\'s an optional field with default being STANDARD
|
|
2431
|
+
* @type {string}
|
|
2432
|
+
* @memberof OrderCreateRefundRequest
|
|
2433
|
+
*/
|
|
2434
|
+
'refund_speed'?: OrderCreateRefundRequestRefundSpeedEnum;
|
|
2435
|
+
/**
|
|
2436
|
+
*
|
|
2437
|
+
* @type {Array<VendorSplit>}
|
|
2438
|
+
* @memberof OrderCreateRefundRequest
|
|
2439
|
+
*/
|
|
2440
|
+
'refund_splits'?: Array<VendorSplit>;
|
|
2441
|
+
}
|
|
2442
|
+
export declare const OrderCreateRefundRequestRefundSpeedEnum: {
|
|
2443
|
+
readonly STANDARD: "STANDARD";
|
|
2444
|
+
readonly INSTANT: "INSTANT";
|
|
2445
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2446
|
+
};
|
|
2447
|
+
export type OrderCreateRefundRequestRefundSpeedEnum = typeof OrderCreateRefundRequestRefundSpeedEnum[keyof typeof OrderCreateRefundRequestRefundSpeedEnum];
|
|
2448
|
+
/**
|
|
2449
|
+
* The complete order entity
|
|
2450
|
+
* @export
|
|
2451
|
+
* @interface OrderEntity
|
|
2452
|
+
*/
|
|
2453
|
+
export interface OrderEntity {
|
|
2454
|
+
/**
|
|
2455
|
+
* unique id generated by cashfree for your order
|
|
2456
|
+
* @type {number}
|
|
2457
|
+
* @memberof OrderEntity
|
|
2458
|
+
*/
|
|
2459
|
+
'cf_order_id'?: number;
|
|
2460
|
+
/**
|
|
2461
|
+
* order_id sent during the api request
|
|
2462
|
+
* @type {string}
|
|
2463
|
+
* @memberof OrderEntity
|
|
2464
|
+
*/
|
|
2465
|
+
'order_id'?: string;
|
|
2466
|
+
/**
|
|
2467
|
+
* Type of the entity.
|
|
2468
|
+
* @type {string}
|
|
2469
|
+
* @memberof OrderEntity
|
|
2470
|
+
*/
|
|
2471
|
+
'entity'?: string;
|
|
2472
|
+
/**
|
|
2473
|
+
* Currency of the order. Example INR
|
|
2474
|
+
* @type {string}
|
|
2475
|
+
* @memberof OrderEntity
|
|
2476
|
+
*/
|
|
2477
|
+
'order_currency'?: string;
|
|
2478
|
+
/**
|
|
2479
|
+
*
|
|
2480
|
+
* @type {number}
|
|
2481
|
+
* @memberof OrderEntity
|
|
2482
|
+
*/
|
|
2483
|
+
'order_amount'?: number;
|
|
2484
|
+
/**
|
|
2485
|
+
* Possible values are - `ACTIVE`: Order does not have a sucessful transaction yet - `PAID`: Order is PAID with one successful transaction - `EXPIRED`: Order was not PAID and not it has expired. No transaction can be initiated for an EXPIRED order.
|
|
2486
|
+
* @type {string}
|
|
2487
|
+
* @memberof OrderEntity
|
|
2488
|
+
*/
|
|
2489
|
+
'order_status'?: string;
|
|
2490
|
+
/**
|
|
2491
|
+
*
|
|
2492
|
+
* @type {string}
|
|
2493
|
+
* @memberof OrderEntity
|
|
2494
|
+
*/
|
|
2495
|
+
'payment_session_id'?: string;
|
|
2496
|
+
/**
|
|
2497
|
+
*
|
|
2498
|
+
* @type {string}
|
|
2499
|
+
* @memberof OrderEntity
|
|
2500
|
+
*/
|
|
2501
|
+
'order_expiry_time'?: string;
|
|
2502
|
+
/**
|
|
2503
|
+
* Additional note for order
|
|
2504
|
+
* @type {string}
|
|
2505
|
+
* @memberof OrderEntity
|
|
2506
|
+
*/
|
|
2507
|
+
'order_note'?: string | null;
|
|
2508
|
+
/**
|
|
2509
|
+
* When the order was created at cashfree\'s server
|
|
2510
|
+
* @type {string}
|
|
2511
|
+
* @memberof OrderEntity
|
|
2512
|
+
*/
|
|
2513
|
+
'created_at'?: string;
|
|
2514
|
+
/**
|
|
2515
|
+
*
|
|
2516
|
+
* @type {VendorSplit}
|
|
2517
|
+
* @memberof OrderEntity
|
|
2518
|
+
*/
|
|
2519
|
+
'order_splits'?: VendorSplit;
|
|
2520
|
+
/**
|
|
2521
|
+
*
|
|
2522
|
+
* @type {CustomerDetails}
|
|
2523
|
+
* @memberof OrderEntity
|
|
2524
|
+
*/
|
|
2525
|
+
'customer_details'?: CustomerDetails;
|
|
2526
|
+
/**
|
|
2527
|
+
*
|
|
2528
|
+
* @type {OrderMeta}
|
|
2529
|
+
* @memberof OrderEntity
|
|
2530
|
+
*/
|
|
2531
|
+
'order_meta'?: OrderMeta;
|
|
2532
|
+
/**
|
|
2533
|
+
*
|
|
2534
|
+
* @type {PaymentURLObject}
|
|
2535
|
+
* @memberof OrderEntity
|
|
2536
|
+
*/
|
|
2537
|
+
'payments'?: PaymentURLObject;
|
|
2538
|
+
/**
|
|
2539
|
+
*
|
|
2540
|
+
* @type {SettlementURLObject}
|
|
2541
|
+
* @memberof OrderEntity
|
|
2542
|
+
*/
|
|
2543
|
+
'settlements'?: SettlementURLObject;
|
|
2544
|
+
/**
|
|
2545
|
+
*
|
|
2546
|
+
* @type {RefundURLObject}
|
|
2547
|
+
* @memberof OrderEntity
|
|
2548
|
+
*/
|
|
2549
|
+
'refunds'?: RefundURLObject;
|
|
2550
|
+
/**
|
|
2551
|
+
* Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added
|
|
2552
|
+
* @type {{ [key: string]: string; }}
|
|
2553
|
+
* @memberof OrderEntity
|
|
2554
|
+
*/
|
|
2555
|
+
'order_tags'?: {
|
|
2556
|
+
[key: string]: string;
|
|
2557
|
+
} | null;
|
|
2558
|
+
}
|
|
2559
|
+
/**
|
|
2560
|
+
* Optional meta details to control how the customer pays and how payment journey completes
|
|
2561
|
+
* @export
|
|
2562
|
+
* @interface OrderMeta
|
|
2563
|
+
*/
|
|
2564
|
+
export interface OrderMeta {
|
|
2565
|
+
/**
|
|
2566
|
+
* The URL to which user will be redirected to after the payment on bank OTP page. Maximum length: 250. The return_url must contain placeholder {order_id}. When redirecting the customer back to the return url from the bank’s OTP page, Cashfree will replace this placeholder with the actual value for that order.
|
|
2567
|
+
* @type {string}
|
|
2568
|
+
* @memberof OrderMeta
|
|
2569
|
+
*/
|
|
2570
|
+
'return_url'?: string | null;
|
|
2571
|
+
/**
|
|
2572
|
+
* Notification URL for server-server communication. Useful when user\'s connection drops while re-directing. NotifyUrl should be an https URL. Maximum length: 250.
|
|
2573
|
+
* @type {string}
|
|
2574
|
+
* @memberof OrderMeta
|
|
2575
|
+
*/
|
|
2576
|
+
'notify_url'?: string | null;
|
|
2577
|
+
/**
|
|
2578
|
+
* Allowed payment modes for this order. Pass comma-separated values among following options - \"cc\", \"dc\", \"ccc\", \"ppc\",\"nb\",\"upi\",\"paypal\",\"app\",\"paylater\",\"cardlessemi\",\"dcemi\",\"ccemi\",\"banktransfer\". Leave it blank to show all available payment methods
|
|
2579
|
+
* @type {any}
|
|
2580
|
+
* @memberof OrderMeta
|
|
2581
|
+
*/
|
|
2582
|
+
'payment_methods'?: any | null;
|
|
2583
|
+
}
|
|
2584
|
+
/**
|
|
2585
|
+
* the data object pay api
|
|
2586
|
+
* @export
|
|
2587
|
+
* @interface OrderPayData
|
|
2588
|
+
*/
|
|
2589
|
+
export interface OrderPayData {
|
|
2590
|
+
/**
|
|
2591
|
+
*
|
|
2592
|
+
* @type {string}
|
|
2593
|
+
* @memberof OrderPayData
|
|
2594
|
+
*/
|
|
2595
|
+
'url'?: string | null;
|
|
2596
|
+
/**
|
|
2597
|
+
*
|
|
2598
|
+
* @type {object}
|
|
2599
|
+
* @memberof OrderPayData
|
|
2600
|
+
*/
|
|
2601
|
+
'payload'?: object | null;
|
|
2602
|
+
/**
|
|
2603
|
+
*
|
|
2604
|
+
* @type {string}
|
|
2605
|
+
* @memberof OrderPayData
|
|
2606
|
+
*/
|
|
2607
|
+
'content_type'?: string | null;
|
|
2608
|
+
/**
|
|
2609
|
+
*
|
|
2610
|
+
* @type {string}
|
|
2611
|
+
* @memberof OrderPayData
|
|
2612
|
+
*/
|
|
2613
|
+
'method'?: string | null;
|
|
2614
|
+
}
|
|
2615
|
+
/**
|
|
2616
|
+
* Order Pay response once you create a transaction for that order
|
|
2617
|
+
* @export
|
|
2618
|
+
* @interface PayOrderEntity
|
|
2619
|
+
*/
|
|
2620
|
+
export interface PayOrderEntity {
|
|
2621
|
+
/**
|
|
2622
|
+
* total amount payable
|
|
2623
|
+
* @type {number}
|
|
2624
|
+
* @memberof PayOrderEntity
|
|
2625
|
+
*/
|
|
2626
|
+
'payment_amount'?: number;
|
|
2627
|
+
/**
|
|
2628
|
+
* Payment identifier created by Cashfree
|
|
2629
|
+
* @type {number}
|
|
2630
|
+
* @memberof PayOrderEntity
|
|
2631
|
+
*/
|
|
2632
|
+
'cf_payment_id'?: number;
|
|
2633
|
+
/**
|
|
2634
|
+
* One of [\"upi\", \"netbanking\", \"card\", \"app\", \"cardless_emi\", \"paylater\", \"banktransfer\"]
|
|
2635
|
+
* @type {string}
|
|
2636
|
+
* @memberof PayOrderEntity
|
|
2637
|
+
*/
|
|
2638
|
+
'payment_method'?: PayOrderEntityPaymentMethodEnum;
|
|
2639
|
+
/**
|
|
2640
|
+
* One of [\"link\", \"collect\", \"qrcode\"]. In an older version we used to support different channels like \'gpay\', \'phonepe\' etc. However, we now support only the following channels - link, collect and qrcode. To process payments using gpay, you will have to provide channel as \'link\' and provider as \'gpay\'
|
|
2641
|
+
* @type {string}
|
|
2642
|
+
* @memberof PayOrderEntity
|
|
2643
|
+
*/
|
|
2644
|
+
'channel'?: PayOrderEntityChannelEnum;
|
|
2645
|
+
/**
|
|
2646
|
+
* One of [\"link\", \"custom\", \"form\"]
|
|
2647
|
+
* @type {string}
|
|
2648
|
+
* @memberof PayOrderEntity
|
|
2649
|
+
*/
|
|
2650
|
+
'action'?: PayOrderEntityActionEnum;
|
|
2651
|
+
/**
|
|
2652
|
+
*
|
|
2653
|
+
* @type {OrderPayData}
|
|
2654
|
+
* @memberof PayOrderEntity
|
|
2655
|
+
*/
|
|
2656
|
+
'data'?: OrderPayData;
|
|
2657
|
+
}
|
|
2658
|
+
export declare const PayOrderEntityPaymentMethodEnum: {
|
|
2659
|
+
readonly NETBANKING: "netbanking";
|
|
2660
|
+
readonly CARD: "card";
|
|
2661
|
+
readonly UPI: "upi";
|
|
2662
|
+
readonly APP: "app";
|
|
2663
|
+
readonly CARDLESS_EMI: "cardless_emi";
|
|
2664
|
+
readonly PAYLATER: "paylater";
|
|
2665
|
+
readonly BANKTRANSFER: "banktransfer";
|
|
2666
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2667
|
+
};
|
|
2668
|
+
export type PayOrderEntityPaymentMethodEnum = typeof PayOrderEntityPaymentMethodEnum[keyof typeof PayOrderEntityPaymentMethodEnum];
|
|
2669
|
+
export declare const PayOrderEntityChannelEnum: {
|
|
2670
|
+
readonly LINK: "link";
|
|
2671
|
+
readonly COLLECT: "collect";
|
|
2672
|
+
readonly QRCODE: "qrcode";
|
|
2673
|
+
readonly POST: "post";
|
|
2674
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2675
|
+
};
|
|
2676
|
+
export type PayOrderEntityChannelEnum = typeof PayOrderEntityChannelEnum[keyof typeof PayOrderEntityChannelEnum];
|
|
2677
|
+
export declare const PayOrderEntityActionEnum: {
|
|
2678
|
+
readonly LINK: "link";
|
|
2679
|
+
readonly CUSTOM: "custom";
|
|
2680
|
+
readonly FORM: "form";
|
|
2681
|
+
readonly POST: "post";
|
|
2682
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2683
|
+
};
|
|
2684
|
+
export type PayOrderEntityActionEnum = typeof PayOrderEntityActionEnum[keyof typeof PayOrderEntityActionEnum];
|
|
2685
|
+
/**
|
|
2686
|
+
* Complete object for the pay api that uses payment method objects
|
|
2687
|
+
* @export
|
|
2688
|
+
* @interface PayOrderRequest
|
|
2689
|
+
*/
|
|
2690
|
+
export interface PayOrderRequest {
|
|
2691
|
+
/**
|
|
2692
|
+
*
|
|
2693
|
+
* @type {string}
|
|
2694
|
+
* @memberof PayOrderRequest
|
|
2695
|
+
*/
|
|
2696
|
+
'payment_session_id': string;
|
|
2697
|
+
/**
|
|
2698
|
+
*
|
|
2699
|
+
* @type {PayOrderRequestPaymentMethod}
|
|
2700
|
+
* @memberof PayOrderRequest
|
|
2701
|
+
*/
|
|
2702
|
+
'payment_method': PayOrderRequestPaymentMethod;
|
|
2703
|
+
/**
|
|
2704
|
+
*
|
|
2705
|
+
* @type {boolean}
|
|
2706
|
+
* @memberof PayOrderRequest
|
|
2707
|
+
*/
|
|
2708
|
+
'save_instrument'?: boolean;
|
|
2709
|
+
/**
|
|
2710
|
+
* This is required if any offers needs to be applied to the order.
|
|
2711
|
+
* @type {string}
|
|
2712
|
+
* @memberof PayOrderRequest
|
|
2713
|
+
*/
|
|
2714
|
+
'offer_id'?: string;
|
|
2715
|
+
}
|
|
2716
|
+
/**
|
|
2717
|
+
* @type PayOrderRequestPaymentMethod
|
|
2718
|
+
* @export
|
|
2719
|
+
*/
|
|
2720
|
+
export type PayOrderRequestPaymentMethod = AppPaymentMethod | CardEMIPaymentMethod | CardPaymentMethod | CardlessEMIPaymentMethod | NetBankingPaymentMethod | PaylaterPaymentMethod | UPIPaymentMethod;
|
|
2721
|
+
/**
|
|
2722
|
+
* Paylater payment method
|
|
2723
|
+
* @export
|
|
2724
|
+
* @interface Paylater
|
|
2725
|
+
*/
|
|
2726
|
+
export interface Paylater {
|
|
2727
|
+
/**
|
|
2728
|
+
* The channel for cardless EMI is always `link`
|
|
2729
|
+
* @type {string}
|
|
2730
|
+
* @memberof Paylater
|
|
2731
|
+
*/
|
|
2732
|
+
'channel'?: string;
|
|
2733
|
+
/**
|
|
2734
|
+
* One of [\"kotak\", \"flexipay\", \"zestmoney\", \"lazypay\", \"olapostpaid\",\"simpl\", \"freechargepaylater\"]. Please note that Flexipay is offered by HDFC bank
|
|
2735
|
+
* @type {string}
|
|
2736
|
+
* @memberof Paylater
|
|
2737
|
+
*/
|
|
2738
|
+
'provider'?: PaylaterProviderEnum;
|
|
2739
|
+
/**
|
|
2740
|
+
* Customers phone number for this payment instrument. If the customer is not eligible you will receive a 400 error with type as \'invalid_request_error\' and code as \'invalid_request_error\'
|
|
2741
|
+
* @type {string}
|
|
2742
|
+
* @memberof Paylater
|
|
2743
|
+
*/
|
|
2744
|
+
'phone'?: string;
|
|
2745
|
+
}
|
|
2746
|
+
export declare const PaylaterProviderEnum: {
|
|
2747
|
+
readonly KOTAK: "kotak";
|
|
2748
|
+
readonly FLEXIPAY: "flexipay";
|
|
2749
|
+
readonly ZESTMONEY: "zestmoney";
|
|
2750
|
+
readonly LAZYPAY: "lazypay";
|
|
2751
|
+
readonly OLAPOSTPAID: "olapostpaid";
|
|
2752
|
+
readonly SIMPL: "simpl";
|
|
2753
|
+
readonly FREECHARGEPAYLATER: "freechargepaylater";
|
|
2754
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2755
|
+
};
|
|
2756
|
+
export type PaylaterProviderEnum = typeof PaylaterProviderEnum[keyof typeof PaylaterProviderEnum];
|
|
2757
|
+
/**
|
|
2758
|
+
* Paylater Entity
|
|
2759
|
+
* @export
|
|
2760
|
+
* @interface PaylaterEntity
|
|
2761
|
+
*/
|
|
2762
|
+
export interface PaylaterEntity {
|
|
2763
|
+
/**
|
|
2764
|
+
*
|
|
2765
|
+
* @type {string}
|
|
2766
|
+
* @memberof PaylaterEntity
|
|
2767
|
+
*/
|
|
2768
|
+
'payment_method'?: string;
|
|
2769
|
+
}
|
|
2770
|
+
/**
|
|
2771
|
+
*
|
|
2772
|
+
* @export
|
|
2773
|
+
* @interface PaylaterOffer
|
|
2774
|
+
*/
|
|
2775
|
+
export interface PaylaterOffer {
|
|
2776
|
+
/**
|
|
2777
|
+
*
|
|
2778
|
+
* @type {string}
|
|
2779
|
+
* @memberof PaylaterOffer
|
|
2780
|
+
*/
|
|
2781
|
+
'provider'?: string;
|
|
2782
|
+
}
|
|
2783
|
+
/**
|
|
2784
|
+
* paylater payment method
|
|
2785
|
+
* @export
|
|
2786
|
+
* @interface PaylaterPaymentMethod
|
|
2787
|
+
*/
|
|
2788
|
+
export interface PaylaterPaymentMethod {
|
|
2789
|
+
/**
|
|
2790
|
+
*
|
|
2791
|
+
* @type {Paylater}
|
|
2792
|
+
* @memberof PaylaterPaymentMethod
|
|
2793
|
+
*/
|
|
2794
|
+
'paylater'?: Paylater;
|
|
2795
|
+
}
|
|
2796
|
+
/**
|
|
2797
|
+
* payment entity full object
|
|
2798
|
+
* @export
|
|
2799
|
+
* @interface PaymentEntity
|
|
2800
|
+
*/
|
|
2801
|
+
export interface PaymentEntity {
|
|
2802
|
+
/**
|
|
2803
|
+
*
|
|
2804
|
+
* @type {number}
|
|
2805
|
+
* @memberof PaymentEntity
|
|
2806
|
+
*/
|
|
2807
|
+
'cf_payment_id'?: number;
|
|
2808
|
+
/**
|
|
2809
|
+
*
|
|
2810
|
+
* @type {string}
|
|
2811
|
+
* @memberof PaymentEntity
|
|
2812
|
+
*/
|
|
2813
|
+
'order_id'?: string;
|
|
2814
|
+
/**
|
|
2815
|
+
*
|
|
2816
|
+
* @type {string}
|
|
2817
|
+
* @memberof PaymentEntity
|
|
2818
|
+
*/
|
|
2819
|
+
'entity'?: string;
|
|
2820
|
+
/**
|
|
2821
|
+
*
|
|
2822
|
+
* @type {ErrorDetailsInPaymentsEntity}
|
|
2823
|
+
* @memberof PaymentEntity
|
|
2824
|
+
*/
|
|
2825
|
+
'error_details'?: ErrorDetailsInPaymentsEntity;
|
|
2826
|
+
/**
|
|
2827
|
+
*
|
|
2828
|
+
* @type {boolean}
|
|
2829
|
+
* @memberof PaymentEntity
|
|
2830
|
+
*/
|
|
2831
|
+
'is_captured'?: boolean;
|
|
2832
|
+
/**
|
|
2833
|
+
* Order amount can be different from payment amount if you collect service fee from the customer
|
|
2834
|
+
* @type {number}
|
|
2835
|
+
* @memberof PaymentEntity
|
|
2836
|
+
*/
|
|
2837
|
+
'order_amount'?: number;
|
|
2838
|
+
/**
|
|
2839
|
+
* Type of payment group. One of [\'upi\', \'card\', \'app\', \'netbanking\', \'paylater\', \'cardless_emi\']
|
|
2840
|
+
* @type {string}
|
|
2841
|
+
* @memberof PaymentEntity
|
|
2842
|
+
*/
|
|
2843
|
+
'payment_group'?: string;
|
|
2844
|
+
/**
|
|
2845
|
+
*
|
|
2846
|
+
* @type {string}
|
|
2847
|
+
* @memberof PaymentEntity
|
|
2848
|
+
*/
|
|
2849
|
+
'payment_currency'?: string;
|
|
2850
|
+
/**
|
|
2851
|
+
*
|
|
2852
|
+
* @type {number}
|
|
2853
|
+
* @memberof PaymentEntity
|
|
2854
|
+
*/
|
|
2855
|
+
'payment_amount'?: number;
|
|
2856
|
+
/**
|
|
2857
|
+
* This is the time when the payment was initiated
|
|
2858
|
+
* @type {string}
|
|
2859
|
+
* @memberof PaymentEntity
|
|
2860
|
+
*/
|
|
2861
|
+
'payment_time'?: string;
|
|
2862
|
+
/**
|
|
2863
|
+
* This is the time when the payment reaches its terminal state
|
|
2864
|
+
* @type {string}
|
|
2865
|
+
* @memberof PaymentEntity
|
|
2866
|
+
*/
|
|
2867
|
+
'payment_completion_time'?: string;
|
|
2868
|
+
/**
|
|
2869
|
+
* The transaction status can be one of [\"SUCCESS\", \"NOT_ATTEMPTED\", \"FAILED\", \"USER_DROPPED\", \"VOID\", \"CANCELLED\", \"PENDING\"]
|
|
2870
|
+
* @type {string}
|
|
2871
|
+
* @memberof PaymentEntity
|
|
2872
|
+
*/
|
|
2873
|
+
'payment_status'?: PaymentEntityPaymentStatusEnum;
|
|
2874
|
+
/**
|
|
2875
|
+
*
|
|
2876
|
+
* @type {string}
|
|
2877
|
+
* @memberof PaymentEntity
|
|
2878
|
+
*/
|
|
2879
|
+
'payment_message'?: string;
|
|
2880
|
+
/**
|
|
2881
|
+
*
|
|
2882
|
+
* @type {string}
|
|
2883
|
+
* @memberof PaymentEntity
|
|
2884
|
+
*/
|
|
2885
|
+
'bank_reference'?: string;
|
|
2886
|
+
/**
|
|
2887
|
+
*
|
|
2888
|
+
* @type {string}
|
|
2889
|
+
* @memberof PaymentEntity
|
|
2890
|
+
*/
|
|
2891
|
+
'auth_id'?: string;
|
|
2892
|
+
/**
|
|
2893
|
+
*
|
|
2894
|
+
* @type {AuthorizationInPaymentsEntity}
|
|
2895
|
+
* @memberof PaymentEntity
|
|
2896
|
+
*/
|
|
2897
|
+
'authorization'?: AuthorizationInPaymentsEntity | null;
|
|
2898
|
+
/**
|
|
2899
|
+
*
|
|
2900
|
+
* @type {PaymentMethodInPaymentsEntity}
|
|
2901
|
+
* @memberof PaymentEntity
|
|
2902
|
+
*/
|
|
2903
|
+
'payment_method'?: PaymentMethodInPaymentsEntity;
|
|
2904
|
+
}
|
|
2905
|
+
export declare const PaymentEntityPaymentStatusEnum: {
|
|
2906
|
+
readonly SUCCESS: "SUCCESS";
|
|
2907
|
+
readonly NOT_ATTEMPTED: "NOT_ATTEMPTED";
|
|
2908
|
+
readonly FAILED: "FAILED";
|
|
2909
|
+
readonly USER_DROPPED: "USER_DROPPED";
|
|
2910
|
+
readonly VOID: "VOID";
|
|
2911
|
+
readonly CANCELLED: "CANCELLED";
|
|
2912
|
+
readonly PENDING: "PENDING";
|
|
2913
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
2914
|
+
};
|
|
2915
|
+
export type PaymentEntityPaymentStatusEnum = typeof PaymentEntityPaymentStatusEnum[keyof typeof PaymentEntityPaymentStatusEnum];
|
|
2916
|
+
/**
|
|
2917
|
+
* payment method app object in payment entity
|
|
2918
|
+
* @export
|
|
2919
|
+
* @interface PaymentMethodAppInPaymentsEntity
|
|
2920
|
+
*/
|
|
2921
|
+
export interface PaymentMethodAppInPaymentsEntity {
|
|
2922
|
+
/**
|
|
2923
|
+
*
|
|
2924
|
+
* @type {string}
|
|
2925
|
+
* @memberof PaymentMethodAppInPaymentsEntity
|
|
2926
|
+
*/
|
|
2927
|
+
'channel'?: string;
|
|
2928
|
+
/**
|
|
2929
|
+
*
|
|
2930
|
+
* @type {string}
|
|
2931
|
+
* @memberof PaymentMethodAppInPaymentsEntity
|
|
2932
|
+
*/
|
|
2933
|
+
'provider'?: string;
|
|
2934
|
+
/**
|
|
2935
|
+
*
|
|
2936
|
+
* @type {string}
|
|
2937
|
+
* @memberof PaymentMethodAppInPaymentsEntity
|
|
2938
|
+
*/
|
|
2939
|
+
'phone'?: string;
|
|
2940
|
+
}
|
|
2941
|
+
/**
|
|
2942
|
+
* payment method card object in payment entity
|
|
2943
|
+
* @export
|
|
2944
|
+
* @interface PaymentMethodCardInPaymentsEntity
|
|
2945
|
+
*/
|
|
2946
|
+
export interface PaymentMethodCardInPaymentsEntity {
|
|
2947
|
+
/**
|
|
2948
|
+
*
|
|
2949
|
+
* @type {string}
|
|
2950
|
+
* @memberof PaymentMethodCardInPaymentsEntity
|
|
2951
|
+
*/
|
|
2952
|
+
'channel'?: string;
|
|
2953
|
+
/**
|
|
2954
|
+
*
|
|
2955
|
+
* @type {string}
|
|
2956
|
+
* @memberof PaymentMethodCardInPaymentsEntity
|
|
2957
|
+
*/
|
|
2958
|
+
'card_number'?: string;
|
|
2959
|
+
/**
|
|
2960
|
+
*
|
|
2961
|
+
* @type {string}
|
|
2962
|
+
* @memberof PaymentMethodCardInPaymentsEntity
|
|
2963
|
+
*/
|
|
2964
|
+
'card_network'?: string;
|
|
2965
|
+
/**
|
|
2966
|
+
*
|
|
2967
|
+
* @type {string}
|
|
2968
|
+
* @memberof PaymentMethodCardInPaymentsEntity
|
|
2969
|
+
*/
|
|
2970
|
+
'card_type'?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
*
|
|
2973
|
+
* @type {string}
|
|
2974
|
+
* @memberof PaymentMethodCardInPaymentsEntity
|
|
2975
|
+
*/
|
|
2976
|
+
'card_country'?: string;
|
|
2977
|
+
/**
|
|
2978
|
+
*
|
|
2979
|
+
* @type {string}
|
|
2980
|
+
* @memberof PaymentMethodCardInPaymentsEntity
|
|
2981
|
+
*/
|
|
2982
|
+
'card_bank_name'?: string;
|
|
2983
|
+
/**
|
|
2984
|
+
*
|
|
2985
|
+
* @type {string}
|
|
2986
|
+
* @memberof PaymentMethodCardInPaymentsEntity
|
|
2987
|
+
*/
|
|
2988
|
+
'card_network_reference_id'?: string;
|
|
2989
|
+
}
|
|
2990
|
+
/**
|
|
2991
|
+
* payment method carless object in payment entity
|
|
2992
|
+
* @export
|
|
2993
|
+
* @interface PaymentMethodCardlessEMIInPaymentsEntity
|
|
2994
|
+
*/
|
|
2995
|
+
export interface PaymentMethodCardlessEMIInPaymentsEntity {
|
|
2996
|
+
/**
|
|
2997
|
+
*
|
|
2998
|
+
* @type {string}
|
|
2999
|
+
* @memberof PaymentMethodCardlessEMIInPaymentsEntity
|
|
3000
|
+
*/
|
|
3001
|
+
'channel'?: string;
|
|
3002
|
+
/**
|
|
3003
|
+
*
|
|
3004
|
+
* @type {string}
|
|
3005
|
+
* @memberof PaymentMethodCardlessEMIInPaymentsEntity
|
|
3006
|
+
*/
|
|
3007
|
+
'provider'?: string;
|
|
3008
|
+
/**
|
|
3009
|
+
*
|
|
3010
|
+
* @type {string}
|
|
3011
|
+
* @memberof PaymentMethodCardlessEMIInPaymentsEntity
|
|
3012
|
+
*/
|
|
3013
|
+
'phone'?: string;
|
|
3014
|
+
}
|
|
3015
|
+
/**
|
|
3016
|
+
* payment methods all
|
|
3017
|
+
* @export
|
|
3018
|
+
* @interface PaymentMethodInPaymentsEntity
|
|
3019
|
+
*/
|
|
3020
|
+
export interface PaymentMethodInPaymentsEntity {
|
|
3021
|
+
/**
|
|
3022
|
+
*
|
|
3023
|
+
* @type {PaymentMethodInPaymentsEntityPaymentMethod}
|
|
3024
|
+
* @memberof PaymentMethodInPaymentsEntity
|
|
3025
|
+
*/
|
|
3026
|
+
'payment_method'?: PaymentMethodInPaymentsEntityPaymentMethod;
|
|
3027
|
+
}
|
|
3028
|
+
/**
|
|
3029
|
+
* @type PaymentMethodInPaymentsEntityPaymentMethod
|
|
3030
|
+
* @export
|
|
3031
|
+
*/
|
|
3032
|
+
export type PaymentMethodInPaymentsEntityPaymentMethod = PaymentMethodAppInPaymentsEntity | PaymentMethodCardInPaymentsEntity | PaymentMethodCardlessEMIInPaymentsEntity | PaymentMethodNetBankingInPaymentsEntity | PaymentMethodPaylaterInPaymentsEntity | PaymentMethodUPIInPaymentsEntity;
|
|
3033
|
+
/**
|
|
3034
|
+
* netbanking payment method object for pay
|
|
3035
|
+
* @export
|
|
3036
|
+
* @interface PaymentMethodNetBankingInPaymentsEntity
|
|
3037
|
+
*/
|
|
3038
|
+
export interface PaymentMethodNetBankingInPaymentsEntity {
|
|
3039
|
+
/**
|
|
3040
|
+
*
|
|
3041
|
+
* @type {string}
|
|
3042
|
+
* @memberof PaymentMethodNetBankingInPaymentsEntity
|
|
3043
|
+
*/
|
|
3044
|
+
'channel': string;
|
|
3045
|
+
/**
|
|
3046
|
+
*
|
|
3047
|
+
* @type {number}
|
|
3048
|
+
* @memberof PaymentMethodNetBankingInPaymentsEntity
|
|
3049
|
+
*/
|
|
3050
|
+
'netbanking_bank_code': number;
|
|
3051
|
+
/**
|
|
3052
|
+
*
|
|
3053
|
+
* @type {string}
|
|
3054
|
+
* @memberof PaymentMethodNetBankingInPaymentsEntity
|
|
3055
|
+
*/
|
|
3056
|
+
'netbanking_bank_name': string;
|
|
3057
|
+
}
|
|
3058
|
+
/**
|
|
3059
|
+
* paylater payment method object for pay api
|
|
3060
|
+
* @export
|
|
3061
|
+
* @interface PaymentMethodPaylaterInPaymentsEntity
|
|
3062
|
+
*/
|
|
3063
|
+
export interface PaymentMethodPaylaterInPaymentsEntity {
|
|
3064
|
+
/**
|
|
3065
|
+
*
|
|
3066
|
+
* @type {string}
|
|
3067
|
+
* @memberof PaymentMethodPaylaterInPaymentsEntity
|
|
3068
|
+
*/
|
|
3069
|
+
'channel'?: string;
|
|
3070
|
+
/**
|
|
3071
|
+
*
|
|
3072
|
+
* @type {string}
|
|
3073
|
+
* @memberof PaymentMethodPaylaterInPaymentsEntity
|
|
3074
|
+
*/
|
|
3075
|
+
'provider'?: string;
|
|
3076
|
+
/**
|
|
3077
|
+
*
|
|
3078
|
+
* @type {string}
|
|
3079
|
+
* @memberof PaymentMethodPaylaterInPaymentsEntity
|
|
3080
|
+
*/
|
|
3081
|
+
'phone'?: string;
|
|
3082
|
+
}
|
|
3083
|
+
/**
|
|
3084
|
+
* UPI payment method for pay api
|
|
3085
|
+
* @export
|
|
3086
|
+
* @interface PaymentMethodUPIInPaymentsEntity
|
|
3087
|
+
*/
|
|
3088
|
+
export interface PaymentMethodUPIInPaymentsEntity {
|
|
3089
|
+
/**
|
|
3090
|
+
*
|
|
3091
|
+
* @type {string}
|
|
3092
|
+
* @memberof PaymentMethodUPIInPaymentsEntity
|
|
3093
|
+
*/
|
|
3094
|
+
'channel': string;
|
|
3095
|
+
/**
|
|
3096
|
+
*
|
|
3097
|
+
* @type {string}
|
|
3098
|
+
* @memberof PaymentMethodUPIInPaymentsEntity
|
|
3099
|
+
*/
|
|
3100
|
+
'upi_id'?: string;
|
|
3101
|
+
}
|
|
3102
|
+
/**
|
|
3103
|
+
* Filter for Payment Methods
|
|
3104
|
+
* @export
|
|
3105
|
+
* @interface PaymentMethodsFilters
|
|
3106
|
+
*/
|
|
3107
|
+
export interface PaymentMethodsFilters {
|
|
3108
|
+
/**
|
|
3109
|
+
* Array of payment methods to be filtered.
|
|
3110
|
+
* @type {Array<string>}
|
|
3111
|
+
* @memberof PaymentMethodsFilters
|
|
3112
|
+
*/
|
|
3113
|
+
'payment_methods'?: Array<string>;
|
|
3114
|
+
}
|
|
3115
|
+
/**
|
|
3116
|
+
* Payment Method Query Object
|
|
3117
|
+
* @export
|
|
3118
|
+
* @interface PaymentMethodsQueries
|
|
3119
|
+
*/
|
|
3120
|
+
export interface PaymentMethodsQueries {
|
|
3121
|
+
/**
|
|
3122
|
+
* Amount of the order.
|
|
3123
|
+
* @type {number}
|
|
3124
|
+
* @memberof PaymentMethodsQueries
|
|
3125
|
+
*/
|
|
3126
|
+
'amount'?: number;
|
|
3127
|
+
}
|
|
3128
|
+
/**
|
|
3129
|
+
* payment mode eligiblity object
|
|
3130
|
+
* @export
|
|
3131
|
+
* @interface PaymentModeDetails
|
|
3132
|
+
*/
|
|
3133
|
+
export interface PaymentModeDetails {
|
|
3134
|
+
/**
|
|
3135
|
+
*
|
|
3136
|
+
* @type {string}
|
|
3137
|
+
* @memberof PaymentModeDetails
|
|
3138
|
+
*/
|
|
3139
|
+
'nick'?: string;
|
|
3140
|
+
/**
|
|
3141
|
+
*
|
|
3142
|
+
* @type {string}
|
|
3143
|
+
* @memberof PaymentModeDetails
|
|
3144
|
+
*/
|
|
3145
|
+
'display'?: string;
|
|
3146
|
+
/**
|
|
3147
|
+
*
|
|
3148
|
+
* @type {boolean}
|
|
3149
|
+
* @memberof PaymentModeDetails
|
|
3150
|
+
*/
|
|
3151
|
+
'eligibility'?: boolean;
|
|
3152
|
+
/**
|
|
3153
|
+
*
|
|
3154
|
+
* @type {number}
|
|
3155
|
+
* @memberof PaymentModeDetails
|
|
3156
|
+
*/
|
|
3157
|
+
'code'?: number;
|
|
3158
|
+
}
|
|
3159
|
+
/**
|
|
3160
|
+
* object for payment success webhook
|
|
3161
|
+
* @export
|
|
3162
|
+
* @interface PaymentSuccessWebhook
|
|
3163
|
+
*/
|
|
3164
|
+
export interface PaymentSuccessWebhook {
|
|
3165
|
+
/**
|
|
3166
|
+
*
|
|
3167
|
+
* @type {WHdata}
|
|
3168
|
+
* @memberof PaymentSuccessWebhook
|
|
3169
|
+
*/
|
|
3170
|
+
'data'?: WHdata;
|
|
3171
|
+
/**
|
|
3172
|
+
*
|
|
3173
|
+
* @type {string}
|
|
3174
|
+
* @memberof PaymentSuccessWebhook
|
|
3175
|
+
*/
|
|
3176
|
+
'event_time'?: string;
|
|
3177
|
+
/**
|
|
3178
|
+
*
|
|
3179
|
+
* @type {string}
|
|
3180
|
+
* @memberof PaymentSuccessWebhook
|
|
3181
|
+
*/
|
|
3182
|
+
'type'?: string;
|
|
3183
|
+
}
|
|
3184
|
+
/**
|
|
3185
|
+
* URL for payment retrieval for an order
|
|
3186
|
+
* @export
|
|
3187
|
+
* @interface PaymentURLObject
|
|
3188
|
+
*/
|
|
3189
|
+
export interface PaymentURLObject {
|
|
3190
|
+
/**
|
|
3191
|
+
*
|
|
3192
|
+
* @type {string}
|
|
3193
|
+
* @memberof PaymentURLObject
|
|
3194
|
+
*/
|
|
3195
|
+
'url'?: string;
|
|
3196
|
+
}
|
|
3197
|
+
/**
|
|
3198
|
+
* Error when rate limit is breached for your api
|
|
3199
|
+
* @export
|
|
3200
|
+
* @interface RateLimitError
|
|
3201
|
+
*/
|
|
3202
|
+
export interface RateLimitError {
|
|
3203
|
+
/**
|
|
3204
|
+
*
|
|
3205
|
+
* @type {string}
|
|
3206
|
+
* @memberof RateLimitError
|
|
3207
|
+
*/
|
|
3208
|
+
'message'?: string;
|
|
3209
|
+
/**
|
|
3210
|
+
*
|
|
3211
|
+
* @type {string}
|
|
3212
|
+
* @memberof RateLimitError
|
|
3213
|
+
*/
|
|
3214
|
+
'code'?: string;
|
|
3215
|
+
/**
|
|
3216
|
+
* rate_limit_error
|
|
3217
|
+
* @type {string}
|
|
3218
|
+
* @memberof RateLimitError
|
|
3219
|
+
*/
|
|
3220
|
+
'type'?: RateLimitErrorTypeEnum;
|
|
3221
|
+
}
|
|
3222
|
+
export declare const RateLimitErrorTypeEnum: {
|
|
3223
|
+
readonly RATE_LIMIT_ERROR: "rate_limit_error";
|
|
3224
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
3225
|
+
};
|
|
3226
|
+
export type RateLimitErrorTypeEnum = typeof RateLimitErrorTypeEnum[keyof typeof RateLimitErrorTypeEnum];
|
|
3227
|
+
/**
|
|
3228
|
+
* Settlement detailed recon response
|
|
3229
|
+
* @export
|
|
3230
|
+
* @interface ReconEntity
|
|
3231
|
+
*/
|
|
3232
|
+
export interface ReconEntity {
|
|
3233
|
+
/**
|
|
3234
|
+
* Specifies from where the next set of settlement details should be fetched.
|
|
3235
|
+
* @type {string}
|
|
3236
|
+
* @memberof ReconEntity
|
|
3237
|
+
*/
|
|
3238
|
+
'cursor'?: string | null;
|
|
3239
|
+
/**
|
|
3240
|
+
* Number of settlements you want to fetch in the next iteration.
|
|
3241
|
+
* @type {number}
|
|
3242
|
+
* @memberof ReconEntity
|
|
3243
|
+
*/
|
|
3244
|
+
'limit'?: number;
|
|
3245
|
+
/**
|
|
3246
|
+
*
|
|
3247
|
+
* @type {Array<ReconEntityDataInner>}
|
|
3248
|
+
* @memberof ReconEntity
|
|
3249
|
+
*/
|
|
3250
|
+
'data'?: Array<ReconEntityDataInner>;
|
|
3251
|
+
}
|
|
3252
|
+
/**
|
|
3253
|
+
*
|
|
3254
|
+
* @export
|
|
3255
|
+
* @interface ReconEntityDataInner
|
|
3256
|
+
*/
|
|
3257
|
+
export interface ReconEntityDataInner {
|
|
3258
|
+
/**
|
|
3259
|
+
* Unique ID associated with the event.
|
|
3260
|
+
* @type {string}
|
|
3261
|
+
* @memberof ReconEntityDataInner
|
|
3262
|
+
*/
|
|
3263
|
+
'event_id'?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* The event type can be SETTLEMENT, PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT.
|
|
3266
|
+
* @type {string}
|
|
3267
|
+
* @memberof ReconEntityDataInner
|
|
3268
|
+
*/
|
|
3269
|
+
'event_type'?: string;
|
|
3270
|
+
/**
|
|
3271
|
+
* Amount that is part of the settlement corresponding to the event.
|
|
3272
|
+
* @type {number}
|
|
3273
|
+
* @memberof ReconEntityDataInner
|
|
3274
|
+
*/
|
|
3275
|
+
'event_settlement_amount'?: number;
|
|
3276
|
+
/**
|
|
3277
|
+
* Amount of the event. Example, refund amount, dispute amount, payment amount, etc.
|
|
3278
|
+
* @type {number}
|
|
3279
|
+
* @memberof ReconEntityDataInner
|
|
3280
|
+
*/
|
|
3281
|
+
'event_amount'?: number;
|
|
3282
|
+
/**
|
|
3283
|
+
* Indicates if it is CREDIT/DEBIT sale.
|
|
3284
|
+
* @type {string}
|
|
3285
|
+
* @memberof ReconEntityDataInner
|
|
3286
|
+
*/
|
|
3287
|
+
'sale_type'?: string | null;
|
|
3288
|
+
/**
|
|
3289
|
+
* Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED.
|
|
3290
|
+
* @type {string}
|
|
3291
|
+
* @memberof ReconEntityDataInner
|
|
3292
|
+
*/
|
|
3293
|
+
'event_status'?: string | null;
|
|
3294
|
+
/**
|
|
3295
|
+
* Recon
|
|
3296
|
+
* @type {string}
|
|
3297
|
+
* @memberof ReconEntityDataInner
|
|
3298
|
+
*/
|
|
3299
|
+
'entity'?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* Time associated with the event. Example, transaction time, dispute initiation time
|
|
3302
|
+
* @type {string}
|
|
3303
|
+
* @memberof ReconEntityDataInner
|
|
3304
|
+
*/
|
|
3305
|
+
'event_time'?: string;
|
|
3306
|
+
/**
|
|
3307
|
+
* Curreny type - INR.
|
|
3308
|
+
* @type {string}
|
|
3309
|
+
* @memberof ReconEntityDataInner
|
|
3310
|
+
*/
|
|
3311
|
+
'event_currency'?: string | null;
|
|
3312
|
+
/**
|
|
3313
|
+
* Unique order ID. Alphanumeric and only \'-\' and \'_\' allowed.
|
|
3314
|
+
* @type {string}
|
|
3315
|
+
* @memberof ReconEntityDataInner
|
|
3316
|
+
*/
|
|
3317
|
+
'order_id'?: string | null;
|
|
3318
|
+
/**
|
|
3319
|
+
* The amount which was passed at the order creation time.
|
|
3320
|
+
* @type {number}
|
|
3321
|
+
* @memberof ReconEntityDataInner
|
|
3322
|
+
*/
|
|
3323
|
+
'order_amount'?: number | null;
|
|
3324
|
+
/**
|
|
3325
|
+
* Customer phone number.
|
|
3326
|
+
* @type {string}
|
|
3327
|
+
* @memberof ReconEntityDataInner
|
|
3328
|
+
*/
|
|
3329
|
+
'customer_phone'?: string | null;
|
|
3330
|
+
/**
|
|
3331
|
+
* Customer email.
|
|
3332
|
+
* @type {string}
|
|
3333
|
+
* @memberof ReconEntityDataInner
|
|
3334
|
+
*/
|
|
3335
|
+
'customer_email'?: string | null;
|
|
3336
|
+
/**
|
|
3337
|
+
* Customer name.
|
|
3338
|
+
* @type {string}
|
|
3339
|
+
* @memberof ReconEntityDataInner
|
|
3340
|
+
*/
|
|
3341
|
+
'customer_name'?: string | null;
|
|
3342
|
+
/**
|
|
3343
|
+
* Payment amount captured.
|
|
3344
|
+
* @type {number}
|
|
3345
|
+
* @memberof ReconEntityDataInner
|
|
3346
|
+
*/
|
|
3347
|
+
'payment_amount'?: number | null;
|
|
3348
|
+
/**
|
|
3349
|
+
* Unique transaction reference number of the payment.
|
|
3350
|
+
* @type {string}
|
|
3351
|
+
* @memberof ReconEntityDataInner
|
|
3352
|
+
*/
|
|
3353
|
+
'payment_utr'?: string | null;
|
|
3354
|
+
/**
|
|
3355
|
+
* Date and time when the payment was initiated.
|
|
3356
|
+
* @type {string}
|
|
3357
|
+
* @memberof ReconEntityDataInner
|
|
3358
|
+
*/
|
|
3359
|
+
'payment_time'?: string | null;
|
|
3360
|
+
/**
|
|
3361
|
+
* Service charge applicable for the payment.
|
|
3362
|
+
* @type {number}
|
|
3363
|
+
* @memberof ReconEntityDataInner
|
|
3364
|
+
*/
|
|
3365
|
+
'payment_service_charge'?: number | null;
|
|
3366
|
+
/**
|
|
3367
|
+
* Service tax applicable on the payment.
|
|
3368
|
+
* @type {number}
|
|
3369
|
+
* @memberof ReconEntityDataInner
|
|
3370
|
+
*/
|
|
3371
|
+
'payment_service_tax'?: number | null;
|
|
3372
|
+
/**
|
|
3373
|
+
* Cashfree Payments unique ID to identify a payment.
|
|
3374
|
+
* @type {number}
|
|
3375
|
+
* @memberof ReconEntityDataInner
|
|
3376
|
+
*/
|
|
3377
|
+
'cf_payment_id'?: number | null;
|
|
3378
|
+
/**
|
|
3379
|
+
* Unique ID to identify the settlement.
|
|
3380
|
+
* @type {number}
|
|
3381
|
+
* @memberof ReconEntityDataInner
|
|
3382
|
+
*/
|
|
3383
|
+
'cf_settlement_id'?: number | null;
|
|
3384
|
+
/**
|
|
3385
|
+
* Date and time when the settlement was processed.
|
|
3386
|
+
* @type {string}
|
|
3387
|
+
* @memberof ReconEntityDataInner
|
|
3388
|
+
*/
|
|
3389
|
+
'settlement_date'?: string | null;
|
|
3390
|
+
/**
|
|
3391
|
+
* Unique transaction reference number of the settlement.
|
|
3392
|
+
* @type {string}
|
|
3393
|
+
* @memberof ReconEntityDataInner
|
|
3394
|
+
*/
|
|
3395
|
+
'settlement_utr'?: string | null;
|
|
3396
|
+
/**
|
|
3397
|
+
* Service charge that is applicable for splitting the payment.
|
|
3398
|
+
* @type {number}
|
|
3399
|
+
* @memberof ReconEntityDataInner
|
|
3400
|
+
*/
|
|
3401
|
+
'split_service_charge'?: number | null;
|
|
3402
|
+
/**
|
|
3403
|
+
* Service tax applicable for splitting the amount to vendors.
|
|
3404
|
+
* @type {number}
|
|
3405
|
+
* @memberof ReconEntityDataInner
|
|
3406
|
+
*/
|
|
3407
|
+
'split_service_tax'?: number | null;
|
|
3408
|
+
/**
|
|
3409
|
+
* Vendor commission applicable for this transaction.
|
|
3410
|
+
* @type {number}
|
|
3411
|
+
* @memberof ReconEntityDataInner
|
|
3412
|
+
*/
|
|
3413
|
+
'vendor_commission'?: number | null;
|
|
3414
|
+
/**
|
|
3415
|
+
* Specifies whether the dispute was closed in favor of the merchant or customer. /n Possible values - Merchant, Customer
|
|
3416
|
+
* @type {string}
|
|
3417
|
+
* @memberof ReconEntityDataInner
|
|
3418
|
+
*/
|
|
3419
|
+
'closed_in_favor_of'?: string | null;
|
|
3420
|
+
/**
|
|
3421
|
+
* Date and time when the dispute was resolved.
|
|
3422
|
+
* @type {string}
|
|
3423
|
+
* @memberof ReconEntityDataInner
|
|
3424
|
+
*/
|
|
3425
|
+
'dispute_resolved_on'?: string | null;
|
|
3426
|
+
/**
|
|
3427
|
+
* Category of the dispute - Dispute code and the reason for dispute is shown.
|
|
3428
|
+
* @type {string}
|
|
3429
|
+
* @memberof ReconEntityDataInner
|
|
3430
|
+
*/
|
|
3431
|
+
'dispute_category'?: string | null;
|
|
3432
|
+
/**
|
|
3433
|
+
* Note regarding the dispute.
|
|
3434
|
+
* @type {string}
|
|
3435
|
+
* @memberof ReconEntityDataInner
|
|
3436
|
+
*/
|
|
3437
|
+
'dispute_note'?: string | null;
|
|
3438
|
+
/**
|
|
3439
|
+
* Date and time when the refund was processed.
|
|
3440
|
+
* @type {string}
|
|
3441
|
+
* @memberof ReconEntityDataInner
|
|
3442
|
+
*/
|
|
3443
|
+
'refund_processed_at'?: string | null;
|
|
3444
|
+
/**
|
|
3445
|
+
* The bank reference number for the refund.
|
|
3446
|
+
* @type {string}
|
|
3447
|
+
* @memberof ReconEntityDataInner
|
|
3448
|
+
*/
|
|
3449
|
+
'refund_arn'?: string | null;
|
|
3450
|
+
/**
|
|
3451
|
+
* A refund note for your reference.
|
|
3452
|
+
* @type {string}
|
|
3453
|
+
* @memberof ReconEntityDataInner
|
|
3454
|
+
*/
|
|
3455
|
+
'refund_note'?: string | null;
|
|
3456
|
+
/**
|
|
3457
|
+
* An unique ID to associate the refund with.
|
|
3458
|
+
* @type {string}
|
|
3459
|
+
* @memberof ReconEntityDataInner
|
|
3460
|
+
*/
|
|
3461
|
+
'refund_id'?: string | null;
|
|
3462
|
+
/**
|
|
3463
|
+
* Other adjustment remarks.
|
|
3464
|
+
* @type {string}
|
|
3465
|
+
* @memberof ReconEntityDataInner
|
|
3466
|
+
*/
|
|
3467
|
+
'adjustment_remarks'?: string | null;
|
|
3468
|
+
/**
|
|
3469
|
+
* Amount that is adjusted from the settlement amount because of any credit/debit event such as refund, refund_reverse etc.
|
|
3470
|
+
* @type {number}
|
|
3471
|
+
* @memberof ReconEntityDataInner
|
|
3472
|
+
*/
|
|
3473
|
+
'adjustment'?: number | null;
|
|
3474
|
+
/**
|
|
3475
|
+
* Service tax applicable on the settlement amount.
|
|
3476
|
+
* @type {number}
|
|
3477
|
+
* @memberof ReconEntityDataInner
|
|
3478
|
+
*/
|
|
3479
|
+
'service_tax'?: number | null;
|
|
3480
|
+
/**
|
|
3481
|
+
* Service charge applicable on the settlement amount.
|
|
3482
|
+
* @type {number}
|
|
3483
|
+
* @memberof ReconEntityDataInner
|
|
3484
|
+
*/
|
|
3485
|
+
'service_charge'?: number | null;
|
|
3486
|
+
/**
|
|
3487
|
+
* Net amount that is settled after considering the adjustments, settlement charge and tax.
|
|
3488
|
+
* @type {number}
|
|
3489
|
+
* @memberof ReconEntityDataInner
|
|
3490
|
+
*/
|
|
3491
|
+
'amount_settled'?: number | null;
|
|
3492
|
+
/**
|
|
3493
|
+
* The start time of the time range of the payments considered for the settlement.
|
|
3494
|
+
* @type {string}
|
|
3495
|
+
* @memberof ReconEntityDataInner
|
|
3496
|
+
*/
|
|
3497
|
+
'payment_from'?: string | null;
|
|
3498
|
+
/**
|
|
3499
|
+
* The end time of time range of the payments considered for the settlement.
|
|
3500
|
+
* @type {string}
|
|
3501
|
+
* @memberof ReconEntityDataInner
|
|
3502
|
+
*/
|
|
3503
|
+
'payment_till'?: string | null;
|
|
3504
|
+
/**
|
|
3505
|
+
* Reason for settlement failure.
|
|
3506
|
+
* @type {string}
|
|
3507
|
+
* @memberof ReconEntityDataInner
|
|
3508
|
+
*/
|
|
3509
|
+
'reason'?: string | null;
|
|
3510
|
+
/**
|
|
3511
|
+
* Date and time when the settlement was initiated.
|
|
3512
|
+
* @type {string}
|
|
3513
|
+
* @memberof ReconEntityDataInner
|
|
3514
|
+
*/
|
|
3515
|
+
'settlement_initiated_on'?: string | null;
|
|
3516
|
+
/**
|
|
3517
|
+
* Type of settlement. Possible values - Standard, Instant, On demand.
|
|
3518
|
+
* @type {string}
|
|
3519
|
+
* @memberof ReconEntityDataInner
|
|
3520
|
+
*/
|
|
3521
|
+
'settlement_type'?: string | null;
|
|
3522
|
+
/**
|
|
3523
|
+
* Settlement charges applicable on the settlement.
|
|
3524
|
+
* @type {number}
|
|
3525
|
+
* @memberof ReconEntityDataInner
|
|
3526
|
+
*/
|
|
3527
|
+
'settlement_charge'?: number | null;
|
|
3528
|
+
/**
|
|
3529
|
+
* Settlement tax applicable on the settlement.
|
|
3530
|
+
* @type {number}
|
|
3531
|
+
* @memberof ReconEntityDataInner
|
|
3532
|
+
*/
|
|
3533
|
+
'settlement_tax'?: number | null;
|
|
3534
|
+
/**
|
|
3535
|
+
* Remarks on the settlement.
|
|
3536
|
+
* @type {string}
|
|
3537
|
+
* @memberof ReconEntityDataInner
|
|
3538
|
+
*/
|
|
3539
|
+
'remarks'?: string | null;
|
|
3540
|
+
}
|
|
3541
|
+
/**
|
|
3542
|
+
* The refund entity
|
|
3543
|
+
* @export
|
|
3544
|
+
* @interface RefundEntity
|
|
3545
|
+
*/
|
|
3546
|
+
export interface RefundEntity {
|
|
3547
|
+
/**
|
|
3548
|
+
* Cashfree Payments ID of the payment for which refund is initiated
|
|
3549
|
+
* @type {number}
|
|
3550
|
+
* @memberof RefundEntity
|
|
3551
|
+
*/
|
|
3552
|
+
'cf_payment_id'?: number;
|
|
3553
|
+
/**
|
|
3554
|
+
* Cashfree Payments ID for a refund
|
|
3555
|
+
* @type {string}
|
|
3556
|
+
* @memberof RefundEntity
|
|
3557
|
+
*/
|
|
3558
|
+
'cf_refund_id'?: string;
|
|
3559
|
+
/**
|
|
3560
|
+
* Merchant’s order Id of the order for which refund is initiated
|
|
3561
|
+
* @type {string}
|
|
3562
|
+
* @memberof RefundEntity
|
|
3563
|
+
*/
|
|
3564
|
+
'order_id'?: string;
|
|
3565
|
+
/**
|
|
3566
|
+
* Merchant’s refund ID of the refund
|
|
3567
|
+
* @type {string}
|
|
3568
|
+
* @memberof RefundEntity
|
|
3569
|
+
*/
|
|
3570
|
+
'refund_id'?: string;
|
|
3571
|
+
/**
|
|
3572
|
+
* Type of object
|
|
3573
|
+
* @type {string}
|
|
3574
|
+
* @memberof RefundEntity
|
|
3575
|
+
*/
|
|
3576
|
+
'entity'?: RefundEntityEntityEnum;
|
|
3577
|
+
/**
|
|
3578
|
+
* Amount that is refunded
|
|
3579
|
+
* @type {number}
|
|
3580
|
+
* @memberof RefundEntity
|
|
3581
|
+
*/
|
|
3582
|
+
'refund_amount'?: number;
|
|
3583
|
+
/**
|
|
3584
|
+
* Currency of the refund amount
|
|
3585
|
+
* @type {string}
|
|
3586
|
+
* @memberof RefundEntity
|
|
3587
|
+
*/
|
|
3588
|
+
'refund_currency'?: string;
|
|
3589
|
+
/**
|
|
3590
|
+
* Note added by merchant for the refund
|
|
3591
|
+
* @type {string}
|
|
3592
|
+
* @memberof RefundEntity
|
|
3593
|
+
*/
|
|
3594
|
+
'refund_note'?: string;
|
|
3595
|
+
/**
|
|
3596
|
+
* This can be one of [\"SUCCESS\", \"PENDING\", \"CANCELLED\", \"ONHOLD\", \"FAILED\"]
|
|
3597
|
+
* @type {string}
|
|
3598
|
+
* @memberof RefundEntity
|
|
3599
|
+
*/
|
|
3600
|
+
'refund_status'?: RefundEntityRefundStatusEnum;
|
|
3601
|
+
/**
|
|
3602
|
+
* The bank reference number for refund
|
|
3603
|
+
* @type {string}
|
|
3604
|
+
* @memberof RefundEntity
|
|
3605
|
+
*/
|
|
3606
|
+
'refund_arn'?: string;
|
|
3607
|
+
/**
|
|
3608
|
+
* Charges in INR for processing refund
|
|
3609
|
+
* @type {number}
|
|
3610
|
+
* @memberof RefundEntity
|
|
3611
|
+
*/
|
|
3612
|
+
'refund_charge'?: number;
|
|
3613
|
+
/**
|
|
3614
|
+
* Description of refund status
|
|
3615
|
+
* @type {string}
|
|
3616
|
+
* @memberof RefundEntity
|
|
3617
|
+
*/
|
|
3618
|
+
'status_description'?: string;
|
|
3619
|
+
/**
|
|
3620
|
+
* Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs
|
|
3621
|
+
* @type {object}
|
|
3622
|
+
* @memberof RefundEntity
|
|
3623
|
+
*/
|
|
3624
|
+
'metadata'?: object | null;
|
|
3625
|
+
/**
|
|
3626
|
+
*
|
|
3627
|
+
* @type {Array<VendorSplit>}
|
|
3628
|
+
* @memberof RefundEntity
|
|
3629
|
+
*/
|
|
3630
|
+
'refund_splits'?: Array<VendorSplit>;
|
|
3631
|
+
/**
|
|
3632
|
+
* This can be one of [\"PAYMENT_AUTO_REFUND\", \"MERCHANT_INITIATED\", \"UNRECONCILED_AUTO_REFUND\"]
|
|
3633
|
+
* @type {string}
|
|
3634
|
+
* @memberof RefundEntity
|
|
3635
|
+
*/
|
|
3636
|
+
'refund_type'?: RefundEntityRefundTypeEnum;
|
|
3637
|
+
/**
|
|
3638
|
+
* Method or speed of processing refund
|
|
3639
|
+
* @type {string}
|
|
3640
|
+
* @memberof RefundEntity
|
|
3641
|
+
*/
|
|
3642
|
+
'refund_mode'?: RefundEntityRefundModeEnum;
|
|
3643
|
+
/**
|
|
3644
|
+
* Time of refund creation
|
|
3645
|
+
* @type {string}
|
|
3646
|
+
* @memberof RefundEntity
|
|
3647
|
+
*/
|
|
3648
|
+
'created_at'?: string;
|
|
3649
|
+
/**
|
|
3650
|
+
* Time when refund was processed successfully
|
|
3651
|
+
* @type {string}
|
|
3652
|
+
* @memberof RefundEntity
|
|
3653
|
+
*/
|
|
3654
|
+
'processed_at'?: string;
|
|
3655
|
+
/**
|
|
3656
|
+
*
|
|
3657
|
+
* @type {RefundSpeed}
|
|
3658
|
+
* @memberof RefundEntity
|
|
3659
|
+
*/
|
|
3660
|
+
'refund_speed'?: RefundSpeed;
|
|
3661
|
+
}
|
|
3662
|
+
export declare const RefundEntityEntityEnum: {
|
|
3663
|
+
readonly REFUND: "refund";
|
|
3664
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
3665
|
+
};
|
|
3666
|
+
export type RefundEntityEntityEnum = typeof RefundEntityEntityEnum[keyof typeof RefundEntityEntityEnum];
|
|
3667
|
+
export declare const RefundEntityRefundStatusEnum: {
|
|
3668
|
+
readonly SUCCESS: "SUCCESS";
|
|
3669
|
+
readonly PENDING: "PENDING";
|
|
3670
|
+
readonly CANCELLED: "CANCELLED";
|
|
3671
|
+
readonly ONHOLD: "ONHOLD";
|
|
3672
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
3673
|
+
};
|
|
3674
|
+
export type RefundEntityRefundStatusEnum = typeof RefundEntityRefundStatusEnum[keyof typeof RefundEntityRefundStatusEnum];
|
|
3675
|
+
export declare const RefundEntityRefundTypeEnum: {
|
|
3676
|
+
readonly PAYMENT_AUTO_REFUND: "PAYMENT_AUTO_REFUND";
|
|
3677
|
+
readonly MERCHANT_INITIATED: "MERCHANT_INITIATED";
|
|
3678
|
+
readonly UNRECONCILED_AUTO_REFUND: "UNRECONCILED_AUTO_REFUND";
|
|
3679
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
3680
|
+
};
|
|
3681
|
+
export type RefundEntityRefundTypeEnum = typeof RefundEntityRefundTypeEnum[keyof typeof RefundEntityRefundTypeEnum];
|
|
3682
|
+
export declare const RefundEntityRefundModeEnum: {
|
|
3683
|
+
readonly STANDARD: "STANDARD";
|
|
3684
|
+
readonly INSTANT: "INSTANT";
|
|
3685
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
3686
|
+
};
|
|
3687
|
+
export type RefundEntityRefundModeEnum = typeof RefundEntityRefundModeEnum[keyof typeof RefundEntityRefundModeEnum];
|
|
3688
|
+
/**
|
|
3689
|
+
* How fast refund has to be proecessed
|
|
3690
|
+
* @export
|
|
3691
|
+
* @interface RefundSpeed
|
|
3692
|
+
*/
|
|
3693
|
+
export interface RefundSpeed {
|
|
3694
|
+
/**
|
|
3695
|
+
* Requested speed of refund.
|
|
3696
|
+
* @type {string}
|
|
3697
|
+
* @memberof RefundSpeed
|
|
3698
|
+
*/
|
|
3699
|
+
'requested'?: string;
|
|
3700
|
+
/**
|
|
3701
|
+
* Accepted speed of refund.
|
|
3702
|
+
* @type {string}
|
|
3703
|
+
* @memberof RefundSpeed
|
|
3704
|
+
*/
|
|
3705
|
+
'accepted'?: string;
|
|
3706
|
+
/**
|
|
3707
|
+
* Processed speed of refund.
|
|
3708
|
+
* @type {string}
|
|
3709
|
+
* @memberof RefundSpeed
|
|
3710
|
+
*/
|
|
3711
|
+
'processed'?: string;
|
|
3712
|
+
/**
|
|
3713
|
+
* Error message, if any for refund_speed request
|
|
3714
|
+
* @type {string}
|
|
3715
|
+
* @memberof RefundSpeed
|
|
3716
|
+
*/
|
|
3717
|
+
'message'?: string;
|
|
3718
|
+
}
|
|
3719
|
+
/**
|
|
3720
|
+
* URL to get refunds for order
|
|
3721
|
+
* @export
|
|
3722
|
+
* @interface RefundURLObject
|
|
3723
|
+
*/
|
|
3724
|
+
export interface RefundURLObject {
|
|
3725
|
+
/**
|
|
3726
|
+
*
|
|
3727
|
+
* @type {string}
|
|
3728
|
+
* @memberof RefundURLObject
|
|
3729
|
+
*/
|
|
3730
|
+
'url'?: string;
|
|
3731
|
+
}
|
|
3732
|
+
/**
|
|
3733
|
+
* Card instrument meta information
|
|
3734
|
+
* @export
|
|
3735
|
+
* @interface SavedInstrumentMeta
|
|
3736
|
+
*/
|
|
3737
|
+
export interface SavedInstrumentMeta {
|
|
3738
|
+
/**
|
|
3739
|
+
* card scheme/network of the saved card. Example visa, mastercard
|
|
3740
|
+
* @type {string}
|
|
3741
|
+
* @memberof SavedInstrumentMeta
|
|
3742
|
+
*/
|
|
3743
|
+
'card_network'?: string;
|
|
3744
|
+
/**
|
|
3745
|
+
* Issuing bank name of saved card
|
|
3746
|
+
* @type {string}
|
|
3747
|
+
* @memberof SavedInstrumentMeta
|
|
3748
|
+
*/
|
|
3749
|
+
'card_bank_name'?: string;
|
|
3750
|
+
/**
|
|
3751
|
+
* Issuing country of saved card
|
|
3752
|
+
* @type {string}
|
|
3753
|
+
* @memberof SavedInstrumentMeta
|
|
3754
|
+
*/
|
|
3755
|
+
'card_country'?: string;
|
|
3756
|
+
/**
|
|
3757
|
+
* Type of saved card
|
|
3758
|
+
* @type {string}
|
|
3759
|
+
* @memberof SavedInstrumentMeta
|
|
3760
|
+
*/
|
|
3761
|
+
'card_type'?: string;
|
|
3762
|
+
/**
|
|
3763
|
+
*
|
|
3764
|
+
* @type {object}
|
|
3765
|
+
* @memberof SavedInstrumentMeta
|
|
3766
|
+
*/
|
|
3767
|
+
'card_token_details'?: object | null;
|
|
3768
|
+
}
|
|
3769
|
+
/**
|
|
3770
|
+
* Settlement entity object
|
|
3771
|
+
* @export
|
|
3772
|
+
* @interface SettlementEntity
|
|
3773
|
+
*/
|
|
3774
|
+
export interface SettlementEntity {
|
|
3775
|
+
/**
|
|
3776
|
+
*
|
|
3777
|
+
* @type {number}
|
|
3778
|
+
* @memberof SettlementEntity
|
|
3779
|
+
*/
|
|
3780
|
+
'cf_payment_id'?: number;
|
|
3781
|
+
/**
|
|
3782
|
+
*
|
|
3783
|
+
* @type {number}
|
|
3784
|
+
* @memberof SettlementEntity
|
|
3785
|
+
*/
|
|
3786
|
+
'cf_settlement_id'?: number;
|
|
3787
|
+
/**
|
|
3788
|
+
*
|
|
3789
|
+
* @type {string}
|
|
3790
|
+
* @memberof SettlementEntity
|
|
3791
|
+
*/
|
|
3792
|
+
'settlement_currency'?: string;
|
|
3793
|
+
/**
|
|
3794
|
+
*
|
|
3795
|
+
* @type {string}
|
|
3796
|
+
* @memberof SettlementEntity
|
|
3797
|
+
*/
|
|
3798
|
+
'order_id'?: string;
|
|
3799
|
+
/**
|
|
3800
|
+
*
|
|
3801
|
+
* @type {string}
|
|
3802
|
+
* @memberof SettlementEntity
|
|
3803
|
+
*/
|
|
3804
|
+
'entity'?: string;
|
|
3805
|
+
/**
|
|
3806
|
+
*
|
|
3807
|
+
* @type {number}
|
|
3808
|
+
* @memberof SettlementEntity
|
|
3809
|
+
*/
|
|
3810
|
+
'order_amount'?: number;
|
|
3811
|
+
/**
|
|
3812
|
+
*
|
|
3813
|
+
* @type {string}
|
|
3814
|
+
* @memberof SettlementEntity
|
|
3815
|
+
*/
|
|
3816
|
+
'payment_time'?: string;
|
|
3817
|
+
/**
|
|
3818
|
+
*
|
|
3819
|
+
* @type {number}
|
|
3820
|
+
* @memberof SettlementEntity
|
|
3821
|
+
*/
|
|
3822
|
+
'service_charge'?: number;
|
|
3823
|
+
/**
|
|
3824
|
+
*
|
|
3825
|
+
* @type {number}
|
|
3826
|
+
* @memberof SettlementEntity
|
|
3827
|
+
*/
|
|
3828
|
+
'service_tax'?: number;
|
|
3829
|
+
/**
|
|
3830
|
+
*
|
|
3831
|
+
* @type {number}
|
|
3832
|
+
* @memberof SettlementEntity
|
|
3833
|
+
*/
|
|
3834
|
+
'settlement_amount'?: number;
|
|
3835
|
+
/**
|
|
3836
|
+
*
|
|
3837
|
+
* @type {number}
|
|
3838
|
+
* @memberof SettlementEntity
|
|
3839
|
+
*/
|
|
3840
|
+
'settlement_id'?: number;
|
|
3841
|
+
/**
|
|
3842
|
+
*
|
|
3843
|
+
* @type {number}
|
|
3844
|
+
* @memberof SettlementEntity
|
|
3845
|
+
*/
|
|
3846
|
+
'transfer_id'?: number;
|
|
3847
|
+
/**
|
|
3848
|
+
*
|
|
3849
|
+
* @type {string}
|
|
3850
|
+
* @memberof SettlementEntity
|
|
3851
|
+
*/
|
|
3852
|
+
'transfer_time'?: string;
|
|
3853
|
+
/**
|
|
3854
|
+
*
|
|
3855
|
+
* @type {string}
|
|
3856
|
+
* @memberof SettlementEntity
|
|
3857
|
+
*/
|
|
3858
|
+
'transfer_utr'?: string;
|
|
3859
|
+
}
|
|
3860
|
+
/**
|
|
3861
|
+
* Recon Request Object
|
|
3862
|
+
* @export
|
|
3863
|
+
* @interface SettlementFetchReconRequest
|
|
3864
|
+
*/
|
|
3865
|
+
export interface SettlementFetchReconRequest {
|
|
3866
|
+
/**
|
|
3867
|
+
*
|
|
3868
|
+
* @type {FetchSettlementsRequestPagination}
|
|
3869
|
+
* @memberof SettlementFetchReconRequest
|
|
3870
|
+
*/
|
|
3871
|
+
'pagination': FetchSettlementsRequestPagination;
|
|
3872
|
+
/**
|
|
3873
|
+
*
|
|
3874
|
+
* @type {FetchSettlementsRequestFilters}
|
|
3875
|
+
* @memberof SettlementFetchReconRequest
|
|
3876
|
+
*/
|
|
3877
|
+
'filters': FetchSettlementsRequestFilters;
|
|
3878
|
+
}
|
|
3879
|
+
/**
|
|
3880
|
+
* Recon object for settlement
|
|
3881
|
+
* @export
|
|
3882
|
+
* @interface SettlementReconEntity
|
|
3883
|
+
*/
|
|
3884
|
+
export interface SettlementReconEntity {
|
|
3885
|
+
/**
|
|
3886
|
+
* Specifies from where the next set of settlement details should be fetched.
|
|
3887
|
+
* @type {string}
|
|
3888
|
+
* @memberof SettlementReconEntity
|
|
3889
|
+
*/
|
|
3890
|
+
'cursor'?: string;
|
|
3891
|
+
/**
|
|
3892
|
+
* Number of settlements you want to fetch in the next iteration.
|
|
3893
|
+
* @type {number}
|
|
3894
|
+
* @memberof SettlementReconEntity
|
|
3895
|
+
*/
|
|
3896
|
+
'limit'?: number;
|
|
3897
|
+
/**
|
|
3898
|
+
*
|
|
3899
|
+
* @type {Array<SettlementReconEntityDataInner>}
|
|
3900
|
+
* @memberof SettlementReconEntity
|
|
3901
|
+
*/
|
|
3902
|
+
'data'?: Array<SettlementReconEntityDataInner>;
|
|
3903
|
+
}
|
|
3904
|
+
/**
|
|
3905
|
+
*
|
|
3906
|
+
* @export
|
|
3907
|
+
* @interface SettlementReconEntityDataInner
|
|
3908
|
+
*/
|
|
3909
|
+
export interface SettlementReconEntityDataInner {
|
|
3910
|
+
/**
|
|
3911
|
+
* Unique ID associated with the event.
|
|
3912
|
+
* @type {string}
|
|
3913
|
+
* @memberof SettlementReconEntityDataInner
|
|
3914
|
+
*/
|
|
3915
|
+
'event_id'?: string;
|
|
3916
|
+
/**
|
|
3917
|
+
* The event type can be PAYMENT, REFUND, REFUND_REVERSAL, DISPUTE, DISPUTE_REVERSAL, CHARGEBACK, CHARGEBACK_REVERSAL, OTHER_ADJUSTMENT.
|
|
3918
|
+
* @type {string}
|
|
3919
|
+
* @memberof SettlementReconEntityDataInner
|
|
3920
|
+
*/
|
|
3921
|
+
'event_type'?: string;
|
|
3922
|
+
/**
|
|
3923
|
+
* Amount that is part of the settlement corresponding to the event.
|
|
3924
|
+
* @type {number}
|
|
3925
|
+
* @memberof SettlementReconEntityDataInner
|
|
3926
|
+
*/
|
|
3927
|
+
'event_settlement_amount'?: number;
|
|
3928
|
+
/**
|
|
3929
|
+
* Amount corresponding to the event. Example, refund amount, dispute amount, payment amount, etc.
|
|
3930
|
+
* @type {number}
|
|
3931
|
+
* @memberof SettlementReconEntityDataInner
|
|
3932
|
+
*/
|
|
3933
|
+
'event_amount'?: number;
|
|
3934
|
+
/**
|
|
3935
|
+
* Indicates if it is CREDIT/DEBIT sale.
|
|
3936
|
+
* @type {string}
|
|
3937
|
+
* @memberof SettlementReconEntityDataInner
|
|
3938
|
+
*/
|
|
3939
|
+
'sale_type'?: string;
|
|
3940
|
+
/**
|
|
3941
|
+
* Status of the event. Example - SUCCESS, FAILED, PENDING, CANCELLED.
|
|
3942
|
+
* @type {string}
|
|
3943
|
+
* @memberof SettlementReconEntityDataInner
|
|
3944
|
+
*/
|
|
3945
|
+
'event_status'?: string;
|
|
3946
|
+
/**
|
|
3947
|
+
* Recon
|
|
3948
|
+
* @type {string}
|
|
3949
|
+
* @memberof SettlementReconEntityDataInner
|
|
3950
|
+
*/
|
|
3951
|
+
'entity'?: string;
|
|
3952
|
+
/**
|
|
3953
|
+
* Time associated with the event. Example, transaction time, dispute initiation time
|
|
3954
|
+
* @type {string}
|
|
3955
|
+
* @memberof SettlementReconEntityDataInner
|
|
3956
|
+
*/
|
|
3957
|
+
'event_time'?: string;
|
|
3958
|
+
/**
|
|
3959
|
+
* Curreny type - INR.
|
|
3960
|
+
* @type {string}
|
|
3961
|
+
* @memberof SettlementReconEntityDataInner
|
|
3962
|
+
*/
|
|
3963
|
+
'event_currency'?: string;
|
|
3964
|
+
/**
|
|
3965
|
+
* Unique order ID. Alphanumeric and only \'-\' and \'_\' allowed.
|
|
3966
|
+
* @type {string}
|
|
3967
|
+
* @memberof SettlementReconEntityDataInner
|
|
3968
|
+
*/
|
|
3969
|
+
'order_id'?: string;
|
|
3970
|
+
/**
|
|
3971
|
+
* The amount which was passed at the order creation time.
|
|
3972
|
+
* @type {number}
|
|
3973
|
+
* @memberof SettlementReconEntityDataInner
|
|
3974
|
+
*/
|
|
3975
|
+
'order_amount'?: number;
|
|
3976
|
+
/**
|
|
3977
|
+
* Customer phone number.
|
|
3978
|
+
* @type {string}
|
|
3979
|
+
* @memberof SettlementReconEntityDataInner
|
|
3980
|
+
*/
|
|
3981
|
+
'customer_phone'?: string;
|
|
3982
|
+
/**
|
|
3983
|
+
* Customer email.
|
|
3984
|
+
* @type {string}
|
|
3985
|
+
* @memberof SettlementReconEntityDataInner
|
|
3986
|
+
*/
|
|
3987
|
+
'customer_email'?: string;
|
|
3988
|
+
/**
|
|
3989
|
+
* Customer name.
|
|
3990
|
+
* @type {string}
|
|
3991
|
+
* @memberof SettlementReconEntityDataInner
|
|
3992
|
+
*/
|
|
3993
|
+
'customer_name'?: string;
|
|
3994
|
+
/**
|
|
3995
|
+
* Payment amount captured.
|
|
3996
|
+
* @type {number}
|
|
3997
|
+
* @memberof SettlementReconEntityDataInner
|
|
3998
|
+
*/
|
|
3999
|
+
'payment_amount'?: number;
|
|
4000
|
+
/**
|
|
4001
|
+
* Unique transaction reference number of the payment.
|
|
4002
|
+
* @type {string}
|
|
4003
|
+
* @memberof SettlementReconEntityDataInner
|
|
4004
|
+
*/
|
|
4005
|
+
'payment_utr'?: string;
|
|
4006
|
+
/**
|
|
4007
|
+
* Date and time when the payment was initiated.
|
|
4008
|
+
* @type {string}
|
|
4009
|
+
* @memberof SettlementReconEntityDataInner
|
|
4010
|
+
*/
|
|
4011
|
+
'payment_time'?: string;
|
|
4012
|
+
/**
|
|
4013
|
+
* Service charge applicable for the payment.
|
|
4014
|
+
* @type {number}
|
|
4015
|
+
* @memberof SettlementReconEntityDataInner
|
|
4016
|
+
*/
|
|
4017
|
+
'payment_service_charge'?: number;
|
|
4018
|
+
/**
|
|
4019
|
+
* Service tax applicable on the payment.
|
|
4020
|
+
* @type {number}
|
|
4021
|
+
* @memberof SettlementReconEntityDataInner
|
|
4022
|
+
*/
|
|
4023
|
+
'payment_service_tax'?: number;
|
|
4024
|
+
/**
|
|
4025
|
+
* Cashfree Payments unique ID to identify a payment.
|
|
4026
|
+
* @type {number}
|
|
4027
|
+
* @memberof SettlementReconEntityDataInner
|
|
4028
|
+
*/
|
|
4029
|
+
'cf_payment_id'?: number;
|
|
4030
|
+
/**
|
|
4031
|
+
* Unique ID to identify the settlement.
|
|
4032
|
+
* @type {number}
|
|
4033
|
+
* @memberof SettlementReconEntityDataInner
|
|
4034
|
+
*/
|
|
4035
|
+
'cf_settlement_id'?: number;
|
|
4036
|
+
/**
|
|
4037
|
+
* Date and time when the settlement was processed.
|
|
4038
|
+
* @type {string}
|
|
4039
|
+
* @memberof SettlementReconEntityDataInner
|
|
4040
|
+
*/
|
|
4041
|
+
'settlement_date'?: string;
|
|
4042
|
+
/**
|
|
4043
|
+
* Unique transaction reference number of the settlement.
|
|
4044
|
+
* @type {string}
|
|
4045
|
+
* @memberof SettlementReconEntityDataInner
|
|
4046
|
+
*/
|
|
4047
|
+
'settlement_utr'?: string;
|
|
4048
|
+
/**
|
|
4049
|
+
* Service charge that is applicable for splitting the payment.
|
|
4050
|
+
* @type {number}
|
|
4051
|
+
* @memberof SettlementReconEntityDataInner
|
|
4052
|
+
*/
|
|
4053
|
+
'split_service_charge'?: number;
|
|
4054
|
+
/**
|
|
4055
|
+
* Service tax applicable for splitting the amount to vendors.
|
|
4056
|
+
* @type {number}
|
|
4057
|
+
* @memberof SettlementReconEntityDataInner
|
|
4058
|
+
*/
|
|
4059
|
+
'split_service_tax'?: number;
|
|
4060
|
+
/**
|
|
4061
|
+
* Vendor commission applicable for this transaction.
|
|
4062
|
+
* @type {number}
|
|
4063
|
+
* @memberof SettlementReconEntityDataInner
|
|
4064
|
+
*/
|
|
4065
|
+
'vendor_commission'?: number;
|
|
4066
|
+
/**
|
|
4067
|
+
* Specifies whether the dispute was closed in favor of the merchant or customer. Possible values - Merchant, Customer.
|
|
4068
|
+
* @type {string}
|
|
4069
|
+
* @memberof SettlementReconEntityDataInner
|
|
4070
|
+
*/
|
|
4071
|
+
'closed_in_favor_of'?: string;
|
|
4072
|
+
/**
|
|
4073
|
+
* Date and time when the dispute was resolved.
|
|
4074
|
+
* @type {string}
|
|
4075
|
+
* @memberof SettlementReconEntityDataInner
|
|
4076
|
+
*/
|
|
4077
|
+
'dispute_resolved_on'?: string;
|
|
4078
|
+
/**
|
|
4079
|
+
* Category of the dispute - Dispute code and the reason for dispute is shown.
|
|
4080
|
+
* @type {string}
|
|
4081
|
+
* @memberof SettlementReconEntityDataInner
|
|
4082
|
+
*/
|
|
4083
|
+
'dispute_category'?: string;
|
|
4084
|
+
/**
|
|
4085
|
+
* Note regarding the dispute.
|
|
4086
|
+
* @type {string}
|
|
4087
|
+
* @memberof SettlementReconEntityDataInner
|
|
4088
|
+
*/
|
|
4089
|
+
'dispute_note'?: string;
|
|
4090
|
+
/**
|
|
4091
|
+
* Date and time when the refund was processed.
|
|
4092
|
+
* @type {string}
|
|
4093
|
+
* @memberof SettlementReconEntityDataInner
|
|
4094
|
+
*/
|
|
4095
|
+
'refund_processed_at'?: string;
|
|
4096
|
+
/**
|
|
4097
|
+
* The bank reference number for refund.
|
|
4098
|
+
* @type {string}
|
|
4099
|
+
* @memberof SettlementReconEntityDataInner
|
|
4100
|
+
*/
|
|
4101
|
+
'refund_arn'?: string;
|
|
4102
|
+
/**
|
|
4103
|
+
* A refund note for your reference.
|
|
4104
|
+
* @type {string}
|
|
4105
|
+
* @memberof SettlementReconEntityDataInner
|
|
4106
|
+
*/
|
|
4107
|
+
'refund_note'?: string;
|
|
4108
|
+
/**
|
|
4109
|
+
* An unique ID associated with the refund.
|
|
4110
|
+
* @type {string}
|
|
4111
|
+
* @memberof SettlementReconEntityDataInner
|
|
4112
|
+
*/
|
|
4113
|
+
'refund_id'?: string;
|
|
4114
|
+
/**
|
|
4115
|
+
* Other adjustment remarks.
|
|
4116
|
+
* @type {string}
|
|
4117
|
+
* @memberof SettlementReconEntityDataInner
|
|
4118
|
+
*/
|
|
4119
|
+
'adjustment_remarks'?: string;
|
|
4120
|
+
}
|
|
4121
|
+
/**
|
|
4122
|
+
* Settlement URL object
|
|
4123
|
+
* @export
|
|
4124
|
+
* @interface SettlementURLObject
|
|
4125
|
+
*/
|
|
4126
|
+
export interface SettlementURLObject {
|
|
4127
|
+
/**
|
|
4128
|
+
*
|
|
4129
|
+
* @type {string}
|
|
4130
|
+
* @memberof SettlementURLObject
|
|
4131
|
+
*/
|
|
4132
|
+
'url'?: string;
|
|
4133
|
+
}
|
|
4134
|
+
/**
|
|
4135
|
+
* Use this if you are creating an order for cashfree\'s softPOS
|
|
4136
|
+
* @export
|
|
4137
|
+
* @interface TerminalDetails
|
|
4138
|
+
*/
|
|
4139
|
+
export interface TerminalDetails {
|
|
4140
|
+
/**
|
|
4141
|
+
* date time at which terminal is added
|
|
4142
|
+
* @type {string}
|
|
4143
|
+
* @memberof TerminalDetails
|
|
4144
|
+
*/
|
|
4145
|
+
'added_on'?: string;
|
|
4146
|
+
/**
|
|
4147
|
+
* cashfree terminal id
|
|
4148
|
+
* @type {number}
|
|
4149
|
+
* @memberof TerminalDetails
|
|
4150
|
+
*/
|
|
4151
|
+
'cf_terminal_id'?: number;
|
|
4152
|
+
/**
|
|
4153
|
+
* last instant when this terminal was updated
|
|
4154
|
+
* @type {string}
|
|
4155
|
+
* @memberof TerminalDetails
|
|
4156
|
+
*/
|
|
4157
|
+
'last_updated_on'?: string;
|
|
4158
|
+
/**
|
|
4159
|
+
* location of terminal
|
|
4160
|
+
* @type {string}
|
|
4161
|
+
* @memberof TerminalDetails
|
|
4162
|
+
*/
|
|
4163
|
+
'terminal_address'?: string;
|
|
4164
|
+
/**
|
|
4165
|
+
* terminal id for merchant reference
|
|
4166
|
+
* @type {string}
|
|
4167
|
+
* @memberof TerminalDetails
|
|
4168
|
+
*/
|
|
4169
|
+
'terminal_id': string;
|
|
4170
|
+
/**
|
|
4171
|
+
* name of terminal/agent/storefront
|
|
4172
|
+
* @type {string}
|
|
4173
|
+
* @memberof TerminalDetails
|
|
4174
|
+
*/
|
|
4175
|
+
'terminal_name'?: string;
|
|
4176
|
+
/**
|
|
4177
|
+
* note given by merchant while creating the terminal
|
|
4178
|
+
* @type {string}
|
|
4179
|
+
* @memberof TerminalDetails
|
|
4180
|
+
*/
|
|
4181
|
+
'terminal_note'?: string;
|
|
4182
|
+
/**
|
|
4183
|
+
* mobile num of the terminal/agent/storefront
|
|
4184
|
+
* @type {string}
|
|
4185
|
+
* @memberof TerminalDetails
|
|
4186
|
+
*/
|
|
4187
|
+
'terminal_phone_no': string;
|
|
4188
|
+
/**
|
|
4189
|
+
* status of terminal active/inactive
|
|
4190
|
+
* @type {string}
|
|
4191
|
+
* @memberof TerminalDetails
|
|
4192
|
+
*/
|
|
4193
|
+
'terminal_status'?: string;
|
|
4194
|
+
/**
|
|
4195
|
+
* To identify the type of terminal product in use, in this case it is SPOS.
|
|
4196
|
+
* @type {string}
|
|
4197
|
+
* @memberof TerminalDetails
|
|
4198
|
+
*/
|
|
4199
|
+
'terminal_type': string;
|
|
4200
|
+
}
|
|
4201
|
+
/**
|
|
4202
|
+
* Create terminal response object
|
|
4203
|
+
* @export
|
|
4204
|
+
* @interface TerminalEntity
|
|
4205
|
+
*/
|
|
4206
|
+
export interface TerminalEntity {
|
|
4207
|
+
/**
|
|
4208
|
+
*
|
|
4209
|
+
* @type {string}
|
|
4210
|
+
* @memberof TerminalEntity
|
|
4211
|
+
*/
|
|
4212
|
+
'added_on'?: string;
|
|
4213
|
+
/**
|
|
4214
|
+
*
|
|
4215
|
+
* @type {number}
|
|
4216
|
+
* @memberof TerminalEntity
|
|
4217
|
+
*/
|
|
4218
|
+
'cf_terminal_id'?: number;
|
|
4219
|
+
/**
|
|
4220
|
+
*
|
|
4221
|
+
* @type {string}
|
|
4222
|
+
* @memberof TerminalEntity
|
|
4223
|
+
*/
|
|
4224
|
+
'last_updated_on'?: string;
|
|
4225
|
+
/**
|
|
4226
|
+
*
|
|
4227
|
+
* @type {string}
|
|
4228
|
+
* @memberof TerminalEntity
|
|
4229
|
+
*/
|
|
4230
|
+
'terminal_address'?: string;
|
|
4231
|
+
/**
|
|
4232
|
+
*
|
|
4233
|
+
* @type {string}
|
|
4234
|
+
* @memberof TerminalEntity
|
|
4235
|
+
*/
|
|
4236
|
+
'terminal_email'?: string;
|
|
4237
|
+
/**
|
|
4238
|
+
*
|
|
4239
|
+
* @type {string}
|
|
4240
|
+
* @memberof TerminalEntity
|
|
4241
|
+
*/
|
|
4242
|
+
'terminal_type'?: string;
|
|
4243
|
+
/**
|
|
4244
|
+
*
|
|
4245
|
+
* @type {string}
|
|
4246
|
+
* @memberof TerminalEntity
|
|
4247
|
+
*/
|
|
4248
|
+
'teminal_id'?: string;
|
|
4249
|
+
/**
|
|
4250
|
+
*
|
|
4251
|
+
* @type {string}
|
|
4252
|
+
* @memberof TerminalEntity
|
|
4253
|
+
*/
|
|
4254
|
+
'terminal_name'?: string;
|
|
4255
|
+
/**
|
|
4256
|
+
*
|
|
4257
|
+
* @type {string}
|
|
4258
|
+
* @memberof TerminalEntity
|
|
4259
|
+
*/
|
|
4260
|
+
'terminal_note'?: string;
|
|
4261
|
+
/**
|
|
4262
|
+
*
|
|
4263
|
+
* @type {string}
|
|
4264
|
+
* @memberof TerminalEntity
|
|
4265
|
+
*/
|
|
4266
|
+
'terminal_phone_no'?: string;
|
|
4267
|
+
/**
|
|
4268
|
+
*
|
|
4269
|
+
* @type {string}
|
|
4270
|
+
* @memberof TerminalEntity
|
|
4271
|
+
*/
|
|
4272
|
+
'terminal_status'?: string;
|
|
4273
|
+
/**
|
|
4274
|
+
*
|
|
4275
|
+
* @type {string}
|
|
4276
|
+
* @memberof TerminalEntity
|
|
4277
|
+
*/
|
|
4278
|
+
'terminal_meta'?: string;
|
|
4279
|
+
}
|
|
4280
|
+
/**
|
|
4281
|
+
* Create terminal response object
|
|
4282
|
+
* @export
|
|
4283
|
+
* @interface TerminalTransactionEntity
|
|
4284
|
+
*/
|
|
4285
|
+
export interface TerminalTransactionEntity {
|
|
4286
|
+
/**
|
|
4287
|
+
*
|
|
4288
|
+
* @type {number}
|
|
4289
|
+
* @memberof TerminalTransactionEntity
|
|
4290
|
+
*/
|
|
4291
|
+
'cf_payment_id'?: number;
|
|
4292
|
+
/**
|
|
4293
|
+
*
|
|
4294
|
+
* @type {number}
|
|
4295
|
+
* @memberof TerminalTransactionEntity
|
|
4296
|
+
*/
|
|
4297
|
+
'payment_amount'?: number;
|
|
4298
|
+
/**
|
|
4299
|
+
*
|
|
4300
|
+
* @type {string}
|
|
4301
|
+
* @memberof TerminalTransactionEntity
|
|
4302
|
+
*/
|
|
4303
|
+
'payment_method'?: string;
|
|
4304
|
+
/**
|
|
4305
|
+
*
|
|
4306
|
+
* @type {string}
|
|
4307
|
+
* @memberof TerminalTransactionEntity
|
|
4308
|
+
*/
|
|
4309
|
+
'payment_url'?: string;
|
|
4310
|
+
/**
|
|
4311
|
+
*
|
|
4312
|
+
* @type {string}
|
|
4313
|
+
* @memberof TerminalTransactionEntity
|
|
4314
|
+
*/
|
|
4315
|
+
'qrcode'?: string;
|
|
4316
|
+
/**
|
|
4317
|
+
*
|
|
4318
|
+
* @type {string}
|
|
4319
|
+
* @memberof TerminalTransactionEntity
|
|
4320
|
+
*/
|
|
4321
|
+
'timeout'?: string;
|
|
4322
|
+
}
|
|
4323
|
+
/**
|
|
4324
|
+
* object when you are using preauth in UPI in order pay
|
|
4325
|
+
* @export
|
|
4326
|
+
* @interface UPIAuthorizeDetails
|
|
4327
|
+
*/
|
|
4328
|
+
export interface UPIAuthorizeDetails {
|
|
4329
|
+
/**
|
|
4330
|
+
* Time by which this authorization should be approved by the customer.
|
|
4331
|
+
* @type {string}
|
|
4332
|
+
* @memberof UPIAuthorizeDetails
|
|
4333
|
+
*/
|
|
4334
|
+
'approve_by'?: string;
|
|
4335
|
+
/**
|
|
4336
|
+
* This is the time when the UPI one time mandate will start
|
|
4337
|
+
* @type {string}
|
|
4338
|
+
* @memberof UPIAuthorizeDetails
|
|
4339
|
+
*/
|
|
4340
|
+
'start_time'?: string;
|
|
4341
|
+
/**
|
|
4342
|
+
* This is the time when the UPI mandate will be over. If the mandate has not been executed by this time, the funds will be returned back to the customer after this time.
|
|
4343
|
+
* @type {string}
|
|
4344
|
+
* @memberof UPIAuthorizeDetails
|
|
4345
|
+
*/
|
|
4346
|
+
'end_time'?: string;
|
|
4347
|
+
}
|
|
4348
|
+
/**
|
|
4349
|
+
* Complete payment method for UPI collect
|
|
4350
|
+
* @export
|
|
4351
|
+
* @interface UPIPaymentMethod
|
|
4352
|
+
*/
|
|
4353
|
+
export interface UPIPaymentMethod {
|
|
4354
|
+
/**
|
|
4355
|
+
*
|
|
4356
|
+
* @type {Upi}
|
|
4357
|
+
* @memberof UPIPaymentMethod
|
|
4358
|
+
*/
|
|
4359
|
+
'upi': Upi;
|
|
4360
|
+
}
|
|
4361
|
+
/**
|
|
4362
|
+
* UPI collect payment method object
|
|
4363
|
+
* @export
|
|
4364
|
+
* @interface Upi
|
|
4365
|
+
*/
|
|
4366
|
+
export interface Upi {
|
|
4367
|
+
/**
|
|
4368
|
+
* Specify the channel through which the payment must be processed. Can be one of [\"link\", \"collect\", \"qrcode\"]
|
|
4369
|
+
* @type {string}
|
|
4370
|
+
* @memberof Upi
|
|
4371
|
+
*/
|
|
4372
|
+
'channel': UpiChannelEnum;
|
|
4373
|
+
/**
|
|
4374
|
+
* Customer UPI VPA to process payment. ### Important This is a required parameter for channel = `collect`
|
|
4375
|
+
* @type {string}
|
|
4376
|
+
* @memberof Upi
|
|
4377
|
+
*/
|
|
4378
|
+
'upi_id'?: string;
|
|
4379
|
+
/**
|
|
4380
|
+
* use this if you want cashfree to show a loader. Sample response below. It is only supported for collect `action:collect` will be returned with `data.url` having the link for redirection
|
|
4381
|
+
* @type {boolean}
|
|
4382
|
+
* @memberof Upi
|
|
4383
|
+
*/
|
|
4384
|
+
'upi_redirect_url'?: boolean;
|
|
4385
|
+
/**
|
|
4386
|
+
* The UPI request will be valid for this expiry minutes. This parameter is only applicable for a UPI collect payment. The default value is 5 minutes. You should keep the minimum as 5 minutes, and maximum as 15 minutes
|
|
4387
|
+
* @type {number}
|
|
4388
|
+
* @memberof Upi
|
|
4389
|
+
*/
|
|
4390
|
+
'upi_expiry_minutes'?: number;
|
|
4391
|
+
/**
|
|
4392
|
+
* For one time mandate on UPI. Set this as authorize_only = true. Please note that you can only use the \"collect\" channel if you are sending a one time mandate request
|
|
4393
|
+
* @type {boolean}
|
|
4394
|
+
* @memberof Upi
|
|
4395
|
+
*/
|
|
4396
|
+
'authorize_only'?: boolean;
|
|
4397
|
+
/**
|
|
4398
|
+
*
|
|
4399
|
+
* @type {UPIAuthorizeDetails}
|
|
4400
|
+
* @memberof Upi
|
|
4401
|
+
*/
|
|
4402
|
+
'authorization'?: UPIAuthorizeDetails;
|
|
4403
|
+
}
|
|
4404
|
+
export declare const UpiChannelEnum: {
|
|
4405
|
+
readonly LINK: "link";
|
|
4406
|
+
readonly COLLECT: "collect";
|
|
4407
|
+
readonly QRCODE: "qrcode";
|
|
4408
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
4409
|
+
};
|
|
4410
|
+
export type UpiChannelEnum = typeof UpiChannelEnum[keyof typeof UpiChannelEnum];
|
|
4411
|
+
/**
|
|
4412
|
+
* Use to split order when cashfree\'s Easy Split is enabled for your account.
|
|
4413
|
+
* @export
|
|
4414
|
+
* @interface VendorSplit
|
|
4415
|
+
*/
|
|
4416
|
+
export interface VendorSplit {
|
|
4417
|
+
/**
|
|
4418
|
+
* Vendor id created in Cashfree system
|
|
4419
|
+
* @type {string}
|
|
4420
|
+
* @memberof VendorSplit
|
|
4421
|
+
*/
|
|
4422
|
+
'vendor_id'?: string;
|
|
4423
|
+
/**
|
|
4424
|
+
* Amount which will be associated with this vendor
|
|
4425
|
+
* @type {number}
|
|
4426
|
+
* @memberof VendorSplit
|
|
4427
|
+
*/
|
|
4428
|
+
'amount'?: number;
|
|
4429
|
+
/**
|
|
4430
|
+
* Percentage of order amount which shall get added to vendor account
|
|
4431
|
+
* @type {number}
|
|
4432
|
+
* @memberof VendorSplit
|
|
4433
|
+
*/
|
|
4434
|
+
'percentage'?: number;
|
|
4435
|
+
}
|
|
4436
|
+
/**
|
|
4437
|
+
* customer details object in webhook
|
|
4438
|
+
* @export
|
|
4439
|
+
* @interface WHcustomerDetails
|
|
4440
|
+
*/
|
|
4441
|
+
export interface WHcustomerDetails {
|
|
4442
|
+
/**
|
|
4443
|
+
*
|
|
4444
|
+
* @type {string}
|
|
4445
|
+
* @memberof WHcustomerDetails
|
|
4446
|
+
*/
|
|
4447
|
+
'customer_name'?: string;
|
|
4448
|
+
/**
|
|
4449
|
+
*
|
|
4450
|
+
* @type {string}
|
|
4451
|
+
* @memberof WHcustomerDetails
|
|
4452
|
+
*/
|
|
4453
|
+
'customer_id'?: string;
|
|
4454
|
+
/**
|
|
4455
|
+
*
|
|
4456
|
+
* @type {string}
|
|
4457
|
+
* @memberof WHcustomerDetails
|
|
4458
|
+
*/
|
|
4459
|
+
'customer_email'?: string;
|
|
4460
|
+
/**
|
|
4461
|
+
*
|
|
4462
|
+
* @type {string}
|
|
4463
|
+
* @memberof WHcustomerDetails
|
|
4464
|
+
*/
|
|
4465
|
+
'customer_phone'?: string;
|
|
4466
|
+
}
|
|
4467
|
+
/**
|
|
4468
|
+
* webhook object
|
|
4469
|
+
* @export
|
|
4470
|
+
* @interface WHdata
|
|
4471
|
+
*/
|
|
4472
|
+
export interface WHdata {
|
|
4473
|
+
/**
|
|
4474
|
+
*
|
|
4475
|
+
* @type {WHorder}
|
|
4476
|
+
* @memberof WHdata
|
|
4477
|
+
*/
|
|
4478
|
+
'order'?: WHorder;
|
|
4479
|
+
/**
|
|
4480
|
+
*
|
|
4481
|
+
* @type {PaymentEntity}
|
|
4482
|
+
* @memberof WHdata
|
|
4483
|
+
*/
|
|
4484
|
+
'payment'?: PaymentEntity;
|
|
4485
|
+
/**
|
|
4486
|
+
*
|
|
4487
|
+
* @type {WHcustomerDetails}
|
|
4488
|
+
* @memberof WHdata
|
|
4489
|
+
*/
|
|
4490
|
+
'customer_details'?: WHcustomerDetails;
|
|
4491
|
+
}
|
|
4492
|
+
/**
|
|
4493
|
+
* order entity in webhook
|
|
4494
|
+
* @export
|
|
4495
|
+
* @interface WHorder
|
|
4496
|
+
*/
|
|
4497
|
+
export interface WHorder {
|
|
4498
|
+
/**
|
|
4499
|
+
*
|
|
4500
|
+
* @type {string}
|
|
4501
|
+
* @memberof WHorder
|
|
4502
|
+
*/
|
|
4503
|
+
'order_id'?: string;
|
|
4504
|
+
/**
|
|
4505
|
+
*
|
|
4506
|
+
* @type {number}
|
|
4507
|
+
* @memberof WHorder
|
|
4508
|
+
*/
|
|
4509
|
+
'order_amount'?: number;
|
|
4510
|
+
/**
|
|
4511
|
+
*
|
|
4512
|
+
* @type {string}
|
|
4513
|
+
* @memberof WHorder
|
|
4514
|
+
*/
|
|
4515
|
+
'order_currency'?: string;
|
|
4516
|
+
/**
|
|
4517
|
+
* Custom Tags in thr form of {\"key\":\"value\"} which can be passed for an order. A maximum of 10 tags can be added
|
|
4518
|
+
* @type {{ [key: string]: string; }}
|
|
4519
|
+
* @memberof WHorder
|
|
4520
|
+
*/
|
|
4521
|
+
'order_tags'?: {
|
|
4522
|
+
[key: string]: string;
|
|
4523
|
+
} | null;
|
|
4524
|
+
}
|
|
4525
|
+
/**
|
|
4526
|
+
*
|
|
4527
|
+
* @export
|
|
4528
|
+
* @interface WalletOffer
|
|
4529
|
+
*/
|
|
4530
|
+
export interface WalletOffer {
|
|
4531
|
+
/**
|
|
4532
|
+
*
|
|
4533
|
+
* @type {string}
|
|
4534
|
+
* @memberof WalletOffer
|
|
4535
|
+
*/
|
|
4536
|
+
'provider'?: string;
|
|
4537
|
+
}
|
|
4538
|
+
/**
|
|
4539
|
+
* TokenVaultApi - object-oriented interface
|
|
4540
|
+
* @export
|
|
4541
|
+
* @class TokenVaultApi
|
|
4542
|
+
* @extends {BaseAPI}
|
|
4543
|
+
*/
|
|
4544
|
+
/**
|
|
4545
|
+
* @export
|
|
4546
|
+
*/
|
|
4547
|
+
export declare const PGCustomerFetchInstrumentsInstrumentTypeEnum: {
|
|
4548
|
+
readonly CARD: "card";
|
|
4549
|
+
readonly UNKNOWN_DEFAULT_OPEN_API: "11184809";
|
|
4550
|
+
};
|
|
4551
|
+
export type PGCustomerFetchInstrumentsInstrumentTypeEnum = typeof PGCustomerFetchInstrumentsInstrumentTypeEnum[keyof typeof PGCustomerFetchInstrumentsInstrumentTypeEnum];
|
|
4552
|
+
declare class Environment {
|
|
4553
|
+
PRODUCTION: CFEnvironment;
|
|
4554
|
+
SANDBOX: CFEnvironment;
|
|
4555
|
+
}
|
|
4556
|
+
export declare class Cashfree {
|
|
4557
|
+
static axios: AxiosInstance;
|
|
4558
|
+
static basePath: string;
|
|
4559
|
+
static XClientId?: string;
|
|
4560
|
+
static XClientSecret?: string;
|
|
4561
|
+
static XPartnerKey?: string;
|
|
4562
|
+
static XClientSignature?: string;
|
|
4563
|
+
static XPartnerMerchantId?: string;
|
|
4564
|
+
static XEnvironment: CFEnvironment;
|
|
4565
|
+
static Environment: Environment;
|
|
4566
|
+
/**
|
|
4567
|
+
* Use this API to get eligible Cardless EMI Payment Methods available for a customer on an order basis their phone number.
|
|
4568
|
+
* @summary Get Eligible Cardless EMI Payment Methods for a customer on an order
|
|
4569
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4570
|
+
* @param {EligibilityFetchCardlessEMIRequest} EligibilityFetchCardlessEMIRequest Request Body to get eligible cardless emi options for a customer and order
|
|
4571
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4572
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4573
|
+
* @param {*} [options] Override http request option.
|
|
4574
|
+
* @throws {RequiredError}
|
|
4575
|
+
* @memberof EligibilityApi
|
|
4576
|
+
*/
|
|
4577
|
+
static PGEligibilityFetchCardlessEMI(x_api_version: string, EligibilityFetchCardlessEMIRequest: EligibilityFetchCardlessEMIRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityCardlessEMIEntity[], any>>;
|
|
4578
|
+
/**
|
|
4579
|
+
* Use this API to get eligible offers for an order_id or order amount.
|
|
4580
|
+
* @summary Get Eligible Offers for an Order
|
|
4581
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4582
|
+
* @param {EligibilityFetchOffersRequest} EligibilityFetchOffersRequest Request Body to get eligible offers for a customer and order
|
|
4583
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4584
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4585
|
+
* @param {*} [options] Override http request option.
|
|
4586
|
+
* @throws {RequiredError}
|
|
4587
|
+
* @memberof EligibilityApi
|
|
4588
|
+
*/
|
|
4589
|
+
static PGEligibilityFetchOffers(x_api_version: string, EligibilityFetchOffersRequest: EligibilityFetchOffersRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityOfferEntity[], any>>;
|
|
4590
|
+
/**
|
|
4591
|
+
* Use this API to get eligible Paylater Payment Methods for a customer on an order.
|
|
4592
|
+
* @summary Get Eligible Paylater for a customer on an order
|
|
4593
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4594
|
+
* @param {EligibilityFetchPaylaterRequest} EligibilityFetchPaylaterRequest Request Body to get eligible paylater options for a customer and order
|
|
4595
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4596
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4597
|
+
* @param {*} [options] Override http request option.
|
|
4598
|
+
* @throws {RequiredError}
|
|
4599
|
+
* @memberof EligibilityApi
|
|
4600
|
+
*/
|
|
4601
|
+
static PGEligibilityFetchPaylater(x_api_version: string, EligibilityFetchPaylaterRequest: EligibilityFetchPaylaterRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityPaylaterEntity[], any>>;
|
|
4602
|
+
/**
|
|
4603
|
+
* Use this API to get eligible Payment Methods
|
|
4604
|
+
* @summary Get eligible Payment Methods
|
|
4605
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4606
|
+
* @param {EligibilityFetchPaymentMethodsRequest} EligibilityFetchPaymentMethodsRequest Request Body to get eligible payment methods for an account and order
|
|
4607
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4608
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4609
|
+
* @param {*} [options] Override http request option.
|
|
4610
|
+
* @throws {RequiredError}
|
|
4611
|
+
* @memberof EligibilityApi
|
|
4612
|
+
*/
|
|
4613
|
+
static PGEligibilityFetchPaymentMethods(x_api_version: string, EligibilityFetchPaymentMethodsRequest: EligibilityFetchPaymentMethodsRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EligibilityPaymentMethodsEntity[], any>>;
|
|
4614
|
+
/**
|
|
4615
|
+
* Use this API to create offers with Cashfree from your backend
|
|
4616
|
+
* @summary Create Offer
|
|
4617
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4618
|
+
* @param {CreateOfferRequest} CreateOfferRequest Request body to create an offer at Cashfree
|
|
4619
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4620
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4621
|
+
* @param {*} [options] Override http request option.
|
|
4622
|
+
* @throws {RequiredError}
|
|
4623
|
+
* @memberof OffersApi
|
|
4624
|
+
*/
|
|
4625
|
+
static PGCreateOffer(x_api_version: string, CreateOfferRequest: CreateOfferRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>;
|
|
4626
|
+
/**
|
|
4627
|
+
* Use this API to get offer by offer_id
|
|
4628
|
+
* @summary Get Offer by ID
|
|
4629
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4630
|
+
* @param {string} offer_id The offer ID for which you want to view the offer details.
|
|
4631
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4632
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4633
|
+
* @param {*} [options] Override http request option.
|
|
4634
|
+
* @throws {RequiredError}
|
|
4635
|
+
* @memberof OffersApi
|
|
4636
|
+
*/
|
|
4637
|
+
static PGFetchOffer(x_api_version: string, offer_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>;
|
|
4638
|
+
/**
|
|
4639
|
+
* ### Order An order is an entity which has a amount and currency associated with it. It is something for which you want to collect payment for. Use this API to create orders with Cashfree from your backend to get a `payment_sessions_id`. You can use the `payment_sessions_id` to create a transaction for the order.
|
|
4640
|
+
* @summary Create Order
|
|
4641
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4642
|
+
* @param {CreateOrderRequest} CreateOrderRequest Request body to create an order at cashfree
|
|
4643
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4644
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4645
|
+
* @param {*} [options] Override http request option.
|
|
4646
|
+
* @throws {RequiredError}
|
|
4647
|
+
* @memberof OrdersApi
|
|
4648
|
+
*/
|
|
4649
|
+
static PGCreateOrder(x_api_version: string, CreateOrderRequest: CreateOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
4650
|
+
/**
|
|
4651
|
+
* Use this API to fetch the order that was created at Cashfree\'s using the `order_id`. ## When to use this API - To check the status of your order - Once the order is PAID - Once your customer returns to `return_url`
|
|
4652
|
+
* @summary Get Order
|
|
4653
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4654
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4655
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4656
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4657
|
+
* @param {*} [options] Override http request option.
|
|
4658
|
+
* @throws {RequiredError}
|
|
4659
|
+
* @memberof OrdersApi
|
|
4660
|
+
*/
|
|
4661
|
+
static PGFetchOrder(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity, any>>;
|
|
4662
|
+
/**
|
|
4663
|
+
* - Use this API to get the payment gateway reconciliation details with date range. - It will have events for your payment account
|
|
4664
|
+
* @summary PG Reconciliation
|
|
4665
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4666
|
+
* @param {FetchReconRequest} FetchReconRequest Request Body for the reconciliation
|
|
4667
|
+
* @param {string} [Content_Type] application/json
|
|
4668
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4669
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4670
|
+
* @param {string} [Accept] application/json
|
|
4671
|
+
* @param {*} [options] Override http request option.
|
|
4672
|
+
* @throws {RequiredError}
|
|
4673
|
+
* @memberof PGReconciliationApi
|
|
4674
|
+
*/
|
|
4675
|
+
static PGFetchRecon(x_api_version: string, FetchReconRequest: FetchReconRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReconEntity, any>>;
|
|
4676
|
+
/**
|
|
4677
|
+
* Use this API to cancel a payment link. No further payments can be done against a cancelled link. Only a link in ACTIVE status can be cancelled.
|
|
4678
|
+
* @summary Cancel Payment Link
|
|
4679
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4680
|
+
* @param {string} link_id The payment link ID for which you want to view the details.
|
|
4681
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4682
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4683
|
+
* @param {*} [options] Override http request option.
|
|
4684
|
+
* @throws {RequiredError}
|
|
4685
|
+
* @memberof PaymentLinksApi
|
|
4686
|
+
*/
|
|
4687
|
+
static PGCancelLink(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
4688
|
+
/**
|
|
4689
|
+
* Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url.
|
|
4690
|
+
* @summary Create Payment Link
|
|
4691
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4692
|
+
* @param {CreateLinkRequest} CreateLinkRequest Request Body to Create Payment Links
|
|
4693
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4694
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4695
|
+
* @param {*} [options] Override http request option.
|
|
4696
|
+
* @throws {RequiredError}
|
|
4697
|
+
* @memberof PaymentLinksApi
|
|
4698
|
+
*/
|
|
4699
|
+
static PGCreateLink(x_api_version: string, CreateLinkRequest: CreateLinkRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
4700
|
+
/**
|
|
4701
|
+
* Use this API to view all details and status of a payment link.
|
|
4702
|
+
* @summary Fetch Payment Link Details
|
|
4703
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4704
|
+
* @param {string} link_id The payment link ID for which you want to view the details.
|
|
4705
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4706
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4707
|
+
* @param {*} [options] Override http request option.
|
|
4708
|
+
* @throws {RequiredError}
|
|
4709
|
+
* @memberof PaymentLinksApi
|
|
4710
|
+
*/
|
|
4711
|
+
static PGFetchLink(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkEntity, any>>;
|
|
4712
|
+
/**
|
|
4713
|
+
* Use this API to view all order details for a payment link.
|
|
4714
|
+
* @summary Get Orders for a Payment Link
|
|
4715
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4716
|
+
* @param {string} link_id The payment link ID for which you want to view the details.
|
|
4717
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4718
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4719
|
+
* @param {*} [options] Override http request option.
|
|
4720
|
+
* @throws {RequiredError}
|
|
4721
|
+
* @memberof PaymentLinksApi
|
|
4722
|
+
*/
|
|
4723
|
+
static PGLinkFetchOrders(x_api_version: string, link_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderEntity[], any>>;
|
|
4724
|
+
/**
|
|
4725
|
+
* Use this API to capture or void a preauthorized payment
|
|
4726
|
+
* @summary Preauthorization
|
|
4727
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4728
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4729
|
+
* @param {AuthorizeOrderRequest} AuthorizeOrderRequest Request to Capture or Void Transactions
|
|
4730
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4731
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4732
|
+
* @param {*} [options] Override http request option.
|
|
4733
|
+
* @throws {RequiredError}
|
|
4734
|
+
* @memberof PaymentsApi
|
|
4735
|
+
*/
|
|
4736
|
+
static PGAuthorizeOrder(x_api_version: string, order_id: string, AuthorizeOrderRequest: AuthorizeOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity, any>>;
|
|
4737
|
+
/**
|
|
4738
|
+
* If you accept OTP on your own page, you can use the below API to send OTP to Cashfree.
|
|
4739
|
+
* @summary Submit or Resend OTP
|
|
4740
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4741
|
+
* @param {string} cf_payment_id The Cashfree payment or transaction ID.
|
|
4742
|
+
* @param {OrderAuthenticatePaymentRequest} OrderAuthenticatePaymentRequest Request body to submit/resend headless OTP. To use this API make sure you have headless OTP enabled for your account
|
|
4743
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4744
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4745
|
+
* @param {*} [options] Override http request option.
|
|
4746
|
+
* @throws {RequiredError}
|
|
4747
|
+
* @memberof PaymentsApi
|
|
4748
|
+
*/
|
|
4749
|
+
static PGOrderAuthenticatePayment(x_api_version: string, cf_payment_id: string, OrderAuthenticatePaymentRequest: OrderAuthenticatePaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderAuthenticateEntity, any>>;
|
|
4750
|
+
/**
|
|
4751
|
+
* Use this API to view payment details of an order for a payment ID.
|
|
4752
|
+
* @summary Get Payment by ID
|
|
4753
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4754
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4755
|
+
* @param {string} cf_payment_id The Cashfree payment or transaction ID.
|
|
4756
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4757
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4758
|
+
* @param {*} [options] Override http request option.
|
|
4759
|
+
* @throws {RequiredError}
|
|
4760
|
+
* @memberof PaymentsApi
|
|
4761
|
+
*/
|
|
4762
|
+
static PGOrderFetchPayment(x_api_version: string, order_id: string, cf_payment_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity, any>>;
|
|
4763
|
+
/**
|
|
4764
|
+
* Use this API to view all payment details for an order.
|
|
4765
|
+
* @summary Get Payments for an Order
|
|
4766
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4767
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4768
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4769
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4770
|
+
* @param {*} [options] Override http request option.
|
|
4771
|
+
* @throws {RequiredError}
|
|
4772
|
+
* @memberof PaymentsApi
|
|
4773
|
+
*/
|
|
4774
|
+
static PGOrderFetchPayments(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentEntity[], any>>;
|
|
4775
|
+
/**
|
|
4776
|
+
* Use this API when you have already created the orders and want Cashfree to process the payment. To use this API S2S flag needs to be enabled from the backend. In case you want to use the cards payment option the PCI DSS flag is required, for more information send an email to \"care@cashfree.com\".
|
|
4777
|
+
* @summary Order Pay
|
|
4778
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4779
|
+
* @param {PayOrderRequest} PayOrderRequest Request body to create a transaction at cashfree using `payment_session_id`
|
|
4780
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4781
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4782
|
+
* @param {*} [options] Override http request option.
|
|
4783
|
+
* @throws {RequiredError}
|
|
4784
|
+
* @memberof PaymentsApi
|
|
4785
|
+
*/
|
|
4786
|
+
static PGPayOrder(x_api_version: string, PayOrderRequest: PayOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PayOrderEntity, any>>;
|
|
4787
|
+
/**
|
|
4788
|
+
* Use this API to initiate refunds.
|
|
4789
|
+
* @summary Create Refund
|
|
4790
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4791
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4792
|
+
* @param {OrderCreateRefundRequest} OrderCreateRefundRequest Request Body to Create Refunds
|
|
4793
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4794
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4795
|
+
* @param {*} [options] Override http request option.
|
|
4796
|
+
* @throws {RequiredError}
|
|
4797
|
+
* @memberof RefundsApi
|
|
4798
|
+
*/
|
|
4799
|
+
static PGOrderCreateRefund(x_api_version: string, order_id: string, OrderCreateRefundRequest: OrderCreateRefundRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity, any>>;
|
|
4800
|
+
/**
|
|
4801
|
+
* Use this API to fetch a specific refund processed on your Cashfree Account.
|
|
4802
|
+
* @summary Get Refund
|
|
4803
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4804
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4805
|
+
* @param {string} refund_id Refund Id of the refund you want to fetch.
|
|
4806
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4807
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4808
|
+
* @param {*} [options] Override http request option.
|
|
4809
|
+
* @throws {RequiredError}
|
|
4810
|
+
* @memberof RefundsApi
|
|
4811
|
+
*/
|
|
4812
|
+
static PGOrderFetchRefund(x_api_version: string, order_id: string, refund_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity, any>>;
|
|
4813
|
+
/**
|
|
4814
|
+
* Use this API to fetch all refunds processed against an order.
|
|
4815
|
+
* @summary Get All Refunds for an Order
|
|
4816
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4817
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4818
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4819
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4820
|
+
* @param {*} [options] Override http request option.
|
|
4821
|
+
* @throws {RequiredError}
|
|
4822
|
+
* @memberof RefundsApi
|
|
4823
|
+
*/
|
|
4824
|
+
static PGOrderFetchRefunds(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefundEntity[], any>>;
|
|
4825
|
+
/**
|
|
4826
|
+
* Use this API to get all settlement details by specifying the settlement ID, settlement UTR or date range.
|
|
4827
|
+
* @summary Get All Settlements
|
|
4828
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4829
|
+
* @param {FetchSettlementsRequest} FetchSettlementsRequest Request Body to get the settlements
|
|
4830
|
+
* @param {string} [Content_Type] application/json
|
|
4831
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4832
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4833
|
+
* @param {string} [Accept] application/json
|
|
4834
|
+
* @param {*} [options] Override http request option.
|
|
4835
|
+
* @throws {RequiredError}
|
|
4836
|
+
* @memberof SettlementReconciliationApi
|
|
4837
|
+
*/
|
|
4838
|
+
static PGFetchSettlements(x_api_version: string, FetchSettlementsRequest: FetchSettlementsRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementEntity, any>>;
|
|
4839
|
+
/**
|
|
4840
|
+
* - Use this API to get settlement reconciliation details using Settlement ID, settlement UTR or date range. - This API will return events for the settlement IDs you want
|
|
4841
|
+
* @summary Settlement Reconciliation
|
|
4842
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4843
|
+
* @param {SettlementFetchReconRequest} SettlementFetchReconRequest Request Body for the settlement reconciliation
|
|
4844
|
+
* @param {string} [Content_Type] application/json
|
|
4845
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4846
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4847
|
+
* @param {string} [Accept] application/json
|
|
4848
|
+
* @param {*} [options] Override http request option.
|
|
4849
|
+
* @throws {RequiredError}
|
|
4850
|
+
* @memberof SettlementReconciliationApi
|
|
4851
|
+
*/
|
|
4852
|
+
static PGSettlementFetchRecon(x_api_version: string, SettlementFetchReconRequest: SettlementFetchReconRequest, Content_Type?: string, x_request_id?: string, x_idempotency_key?: string, Accept?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementReconEntity, any>>;
|
|
4853
|
+
/**
|
|
4854
|
+
* Use this API to view all the settlements of a particular order.
|
|
4855
|
+
* @summary Get Settlements by Order ID
|
|
4856
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4857
|
+
* @param {string} order_id The id which uniquely identifies your order
|
|
4858
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4859
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4860
|
+
* @param {*} [options] Override http request option.
|
|
4861
|
+
* @throws {RequiredError}
|
|
4862
|
+
* @memberof SettlementsApi
|
|
4863
|
+
*/
|
|
4864
|
+
static PGOrderFetchSettlement(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SettlementEntity, any>>;
|
|
4865
|
+
/**
|
|
4866
|
+
* Use this API to create new terminals to use softPOS.
|
|
4867
|
+
* @summary Create Terminal
|
|
4868
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4869
|
+
* @param {CreateTerminalRequest} CreateTerminalRequest Request Body to Create Terminal for SPOS
|
|
4870
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4871
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4872
|
+
* @param {*} [options] Override http request option.
|
|
4873
|
+
* @throws {RequiredError}
|
|
4874
|
+
* @memberof SoftPOSApi
|
|
4875
|
+
*/
|
|
4876
|
+
static SposCreateTerminal(x_api_version: string, CreateTerminalRequest: CreateTerminalRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalEntity, any>>;
|
|
4877
|
+
/**
|
|
4878
|
+
* Use this API to create a new terminal transaction. To use this API you should first create an order using the Create Order API. Also, you need to enter the terminal details while creating the order and pass the same terminal information while creating a transaction using the below mentioned API.
|
|
4879
|
+
* @summary Create Terminal
|
|
4880
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4881
|
+
* @param {CreateTerminalTransactionRequest} CreateTerminalTransactionRequest Request body to create a terminal transaction
|
|
4882
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4883
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4884
|
+
* @param {*} [options] Override http request option.
|
|
4885
|
+
* @throws {RequiredError}
|
|
4886
|
+
* @memberof SoftPOSApi
|
|
4887
|
+
*/
|
|
4888
|
+
static SposCreateTerminalTransaction(x_api_version: string, CreateTerminalTransactionRequest: CreateTerminalTransactionRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalTransactionEntity, any>>;
|
|
4889
|
+
/**
|
|
4890
|
+
* Use this API to view all details of a terminal.
|
|
4891
|
+
* @summary Get terminal status using phone number
|
|
4892
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4893
|
+
* @param {string} terminal_phone_no The terminal for which you want to view the order details.
|
|
4894
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4895
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4896
|
+
* @param {*} [options] Override http request option.
|
|
4897
|
+
* @throws {RequiredError}
|
|
4898
|
+
* @memberof SoftPOSApi
|
|
4899
|
+
*/
|
|
4900
|
+
static SposFetchTerminal(x_api_version: string, terminal_phone_no: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalEntity, any>>;
|
|
4901
|
+
/**
|
|
4902
|
+
* You can fetch all the StaticQRs corresponding to given terminal id or phone number. Provide either the terminal_phone_no or terminal_id in the request.
|
|
4903
|
+
* @summary Fetch Terminal QR Codes
|
|
4904
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4905
|
+
* @param {string} terminal_phone_no Phone number assigned to the terminal. Required if you are not providing the cf_terminal_id in the request.
|
|
4906
|
+
* @param {string} cf_terminal_id Cashfree terminal id for which you want to get staticQRs. Required if you are not providing the terminal_phone_number in the request.
|
|
4907
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4908
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4909
|
+
* @param {*} [options] Override http request option.
|
|
4910
|
+
* @throws {RequiredError}
|
|
4911
|
+
* @memberof SoftPOSApi
|
|
4912
|
+
*/
|
|
4913
|
+
static SposFetchTerminalQRCodes(x_api_version: string, terminal_phone_no: string, cf_terminal_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchTerminalQRCodesEntity[], any>>;
|
|
4914
|
+
/**
|
|
4915
|
+
* Use this API to delete a saved card instrument for a customer_id and instrument_id
|
|
4916
|
+
* @summary Delete Saved Card Instrument
|
|
4917
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4918
|
+
* @param {string} customer_id Your Customer ID that you had sent during create order API `POST/orders`
|
|
4919
|
+
* @param {string} instrument_id The instrument_id which needs to be deleted
|
|
4920
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4921
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4922
|
+
* @param {*} [options] Override http request option.
|
|
4923
|
+
* @throws {RequiredError}
|
|
4924
|
+
* @memberof TokenVaultApi
|
|
4925
|
+
*/
|
|
4926
|
+
static PGCustomerDeleteInstrument(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity, any>>;
|
|
4927
|
+
/**
|
|
4928
|
+
* Use this API to fetch a single specific saved card for a customer_id by it\'s instrument_id
|
|
4929
|
+
* @summary Fetch Specific Saved Card Instrument
|
|
4930
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4931
|
+
* @param {string} customer_id Your Customer ID that you had sent during create order API `POST/orders`
|
|
4932
|
+
* @param {string} instrument_id The instrument_id of the saved instrument which needs to be queried
|
|
4933
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4934
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4935
|
+
* @param {*} [options] Override http request option.
|
|
4936
|
+
* @throws {RequiredError}
|
|
4937
|
+
* @memberof TokenVaultApi
|
|
4938
|
+
*/
|
|
4939
|
+
static PGCustomerFetchInstrument(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity, any>>;
|
|
4940
|
+
/**
|
|
4941
|
+
* Use this API to fetch saved cards for a customer_id
|
|
4942
|
+
* @summary Fetch All Saved Card Instrument
|
|
4943
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4944
|
+
* @param {string} customer_id Your Customer ID that you had sent during create order API `POST/orders`
|
|
4945
|
+
* @param {PGCustomerFetchInstrumentsInstrumentTypeEnum} instrument_type Payment mode or type of saved instrument
|
|
4946
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4947
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4948
|
+
* @param {*} [options] Override http request option.
|
|
4949
|
+
* @throws {RequiredError}
|
|
4950
|
+
* @memberof TokenVaultApi
|
|
4951
|
+
*/
|
|
4952
|
+
static PGCustomerFetchInstruments(x_api_version: string, customer_id: string, instrument_type: PGCustomerFetchInstrumentsInstrumentTypeEnum, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InstrumentEntity[], any>>;
|
|
4953
|
+
/**
|
|
4954
|
+
* Use this API To get the card network token, token expiry and cryptogram for a saved card instrument using instrument id
|
|
4955
|
+
* @summary Fetch cryptogram for a saved card instrument
|
|
4956
|
+
* @param {string} x_api_version API version to be used. Format is in YYYY-MM-DD
|
|
4957
|
+
* @param {string} customer_id Your Customer ID that you had sent during create order API `POST/orders`
|
|
4958
|
+
* @param {string} instrument_id The instrument_id of the saved card instrument which needs to be queried
|
|
4959
|
+
* @param {string} [x_request_id] Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
|
|
4960
|
+
* @param {string} [x_idempotency_key] Idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors. Currently supported on all POST calls that uses x-client-id & x-client-secret. To use enable, pass x-idempotency-key in the request header. The value of this header must be unique to each operation you are trying to do. One example can be to use the same order_id that you pass while creating orders
|
|
4961
|
+
* @param {*} [options] Override http request option.
|
|
4962
|
+
* @throws {RequiredError}
|
|
4963
|
+
* @memberof TokenVaultApi
|
|
4964
|
+
*/
|
|
4965
|
+
static PGCustomerInstrumentsFetchCryptogram(x_api_version: string, customer_id: string, instrument_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CryptogramEntity, any>>;
|
|
4966
|
+
}
|
|
4967
|
+
export {};
|