@ekoindia/eps-transact-mcp 0.1.21 → 0.1.23
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/data/eps.json +1107 -99
- package/package.json +1 -1
package/data/eps.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"meta": {
|
|
3
3
|
"org": "ekoindia",
|
|
4
4
|
"apiVersion": "v3",
|
|
5
|
-
"bundleVersion": "
|
|
5
|
+
"bundleVersion": "ceae6d30",
|
|
6
6
|
"environments": [
|
|
7
7
|
{
|
|
8
8
|
"id": "sandbox",
|
|
@@ -291,8 +291,10 @@
|
|
|
291
291
|
"name": "client_ref_id",
|
|
292
292
|
"type": "string",
|
|
293
293
|
"required": false,
|
|
294
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
294
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
295
295
|
"example": "2026010100123456789",
|
|
296
|
+
"format": "client-ref",
|
|
297
|
+
"maxLength": 20,
|
|
296
298
|
"in": "query"
|
|
297
299
|
},
|
|
298
300
|
{
|
|
@@ -593,8 +595,10 @@
|
|
|
593
595
|
"name": "client_ref_id",
|
|
594
596
|
"type": "string",
|
|
595
597
|
"required": false,
|
|
596
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
598
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
597
599
|
"example": "2026010100123456789",
|
|
600
|
+
"format": "client-ref",
|
|
601
|
+
"maxLength": 20,
|
|
598
602
|
"in": "body"
|
|
599
603
|
},
|
|
600
604
|
{
|
|
@@ -616,6 +620,7 @@
|
|
|
616
620
|
{
|
|
617
621
|
"name": "dob",
|
|
618
622
|
"type": "string",
|
|
623
|
+
"format": "date",
|
|
619
624
|
"required": true,
|
|
620
625
|
"description": "Date of birth in YYYY-MM-DD format.",
|
|
621
626
|
"example": "1990-05-15",
|
|
@@ -778,8 +783,10 @@
|
|
|
778
783
|
"name": "client_ref_id",
|
|
779
784
|
"type": "string",
|
|
780
785
|
"required": false,
|
|
781
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
786
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
782
787
|
"example": "2026010100123456789",
|
|
788
|
+
"format": "client-ref",
|
|
789
|
+
"maxLength": 20,
|
|
783
790
|
"in": "body"
|
|
784
791
|
},
|
|
785
792
|
{
|
|
@@ -793,6 +800,7 @@
|
|
|
793
800
|
{
|
|
794
801
|
"name": "aadhar",
|
|
795
802
|
"type": "string",
|
|
803
|
+
"format": "aadhaar",
|
|
796
804
|
"required": true,
|
|
797
805
|
"description": "12-digit Aadhaar number of the sender.",
|
|
798
806
|
"example": "234567890123",
|
|
@@ -977,8 +985,10 @@
|
|
|
977
985
|
"name": "client_ref_id",
|
|
978
986
|
"type": "string",
|
|
979
987
|
"required": false,
|
|
980
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
988
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
981
989
|
"example": "2026010100123456789",
|
|
990
|
+
"format": "client-ref",
|
|
991
|
+
"maxLength": 20,
|
|
982
992
|
"in": "body"
|
|
983
993
|
},
|
|
984
994
|
{
|
|
@@ -1170,8 +1180,10 @@
|
|
|
1170
1180
|
"name": "client_ref_id",
|
|
1171
1181
|
"type": "string",
|
|
1172
1182
|
"required": false,
|
|
1173
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
1183
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
1174
1184
|
"example": "2026010100123456789",
|
|
1185
|
+
"format": "client-ref",
|
|
1186
|
+
"maxLength": 20,
|
|
1175
1187
|
"in": "query"
|
|
1176
1188
|
},
|
|
1177
1189
|
{
|
|
@@ -1448,8 +1460,10 @@
|
|
|
1448
1460
|
"name": "client_ref_id",
|
|
1449
1461
|
"type": "string",
|
|
1450
1462
|
"required": false,
|
|
1451
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
1463
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
1452
1464
|
"example": "2026010100123456789",
|
|
1465
|
+
"format": "client-ref",
|
|
1466
|
+
"maxLength": 20,
|
|
1453
1467
|
"in": "body"
|
|
1454
1468
|
},
|
|
1455
1469
|
{
|
|
@@ -1479,6 +1493,7 @@
|
|
|
1479
1493
|
{
|
|
1480
1494
|
"name": "ifsc",
|
|
1481
1495
|
"type": "string",
|
|
1496
|
+
"format": "ifsc",
|
|
1482
1497
|
"required": true,
|
|
1483
1498
|
"description": "IFSC code of the beneficiary's bank branch.",
|
|
1484
1499
|
"example": "SBIN0007515",
|
|
@@ -1676,8 +1691,10 @@
|
|
|
1676
1691
|
"name": "client_ref_id",
|
|
1677
1692
|
"type": "string",
|
|
1678
1693
|
"required": false,
|
|
1679
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
1694
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
1680
1695
|
"example": "2026010100123456789",
|
|
1696
|
+
"format": "client-ref",
|
|
1697
|
+
"maxLength": 20,
|
|
1681
1698
|
"in": "body"
|
|
1682
1699
|
},
|
|
1683
1700
|
{
|
|
@@ -2257,8 +2274,10 @@
|
|
|
2257
2274
|
"name": "client_ref_id",
|
|
2258
2275
|
"type": "string",
|
|
2259
2276
|
"required": false,
|
|
2260
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
2277
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
2261
2278
|
"example": "2026010100123456789",
|
|
2279
|
+
"format": "client-ref",
|
|
2280
|
+
"maxLength": 20,
|
|
2262
2281
|
"in": "body"
|
|
2263
2282
|
},
|
|
2264
2283
|
{
|
|
@@ -2298,6 +2317,7 @@
|
|
|
2298
2317
|
"name": "ifsc",
|
|
2299
2318
|
"label": "Settlement Account IFSC",
|
|
2300
2319
|
"type": "string",
|
|
2320
|
+
"format": "ifsc",
|
|
2301
2321
|
"required": true,
|
|
2302
2322
|
"description": "IFSC of the branch holding the settlement `account`. 11 characters.",
|
|
2303
2323
|
"example": "SBIN0007515",
|
|
@@ -2343,6 +2363,7 @@
|
|
|
2343
2363
|
"name": "aadhar",
|
|
2344
2364
|
"label": "Aadhaar Number",
|
|
2345
2365
|
"type": "string",
|
|
2366
|
+
"format": "aadhaar",
|
|
2346
2367
|
"required": true,
|
|
2347
2368
|
"description": "12-digit Aadhaar number of the sender.",
|
|
2348
2369
|
"example": "123456789012",
|
|
@@ -2379,6 +2400,7 @@
|
|
|
2379
2400
|
"name": "latlong",
|
|
2380
2401
|
"label": "Geolocation",
|
|
2381
2402
|
"type": "string",
|
|
2403
|
+
"format": "lat-long",
|
|
2382
2404
|
"required": true,
|
|
2383
2405
|
"description": "GPS coordinates of the agent for whom AePS Fingpay service is being activated. Format: <latitude,longitude>",
|
|
2384
2406
|
"example": "28.6139,77.2090",
|
|
@@ -2560,8 +2582,10 @@
|
|
|
2560
2582
|
"name": "client_ref_id",
|
|
2561
2583
|
"type": "string",
|
|
2562
2584
|
"required": false,
|
|
2563
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
2585
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
2564
2586
|
"example": "2026010100123456789",
|
|
2587
|
+
"format": "client-ref",
|
|
2588
|
+
"maxLength": 20,
|
|
2565
2589
|
"in": "query"
|
|
2566
2590
|
}
|
|
2567
2591
|
],
|
|
@@ -2723,8 +2747,10 @@
|
|
|
2723
2747
|
"name": "client_ref_id",
|
|
2724
2748
|
"type": "string",
|
|
2725
2749
|
"required": false,
|
|
2726
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
2750
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
2727
2751
|
"example": "2026010100123456789",
|
|
2752
|
+
"format": "client-ref",
|
|
2753
|
+
"maxLength": 20,
|
|
2728
2754
|
"in": "query"
|
|
2729
2755
|
}
|
|
2730
2756
|
],
|
|
@@ -2897,8 +2923,10 @@
|
|
|
2897
2923
|
"name": "client_ref_id",
|
|
2898
2924
|
"type": "string",
|
|
2899
2925
|
"required": false,
|
|
2900
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
2926
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
2901
2927
|
"example": "2026010100123456789",
|
|
2928
|
+
"format": "client-ref",
|
|
2929
|
+
"maxLength": 20,
|
|
2902
2930
|
"in": "body"
|
|
2903
2931
|
},
|
|
2904
2932
|
{
|
|
@@ -2928,6 +2956,7 @@
|
|
|
2928
2956
|
{
|
|
2929
2957
|
"name": "latlong",
|
|
2930
2958
|
"type": "string",
|
|
2959
|
+
"format": "lat-long",
|
|
2931
2960
|
"required": true,
|
|
2932
2961
|
"description": "Agent's GPS coordinates as `latitude,longitude`. Required for security and fraud prevention.",
|
|
2933
2962
|
"example": "28.6139,77.2090",
|
|
@@ -3089,8 +3118,10 @@
|
|
|
3089
3118
|
"name": "client_ref_id",
|
|
3090
3119
|
"type": "string",
|
|
3091
3120
|
"required": false,
|
|
3092
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
3121
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
3093
3122
|
"example": "2026010100123456789",
|
|
3123
|
+
"format": "client-ref",
|
|
3124
|
+
"maxLength": 20,
|
|
3094
3125
|
"in": "body"
|
|
3095
3126
|
},
|
|
3096
3127
|
{
|
|
@@ -3144,6 +3175,7 @@
|
|
|
3144
3175
|
{
|
|
3145
3176
|
"name": "latlong",
|
|
3146
3177
|
"type": "string",
|
|
3178
|
+
"format": "lat-long",
|
|
3147
3179
|
"required": true,
|
|
3148
3180
|
"description": "Agent's GPS coordinates as `latitude,longitude`. Required for security and fraud prevention.",
|
|
3149
3181
|
"example": "28.6139,77.2090",
|
|
@@ -3299,8 +3331,10 @@
|
|
|
3299
3331
|
"name": "client_ref_id",
|
|
3300
3332
|
"type": "string",
|
|
3301
3333
|
"required": false,
|
|
3302
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
3334
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
3303
3335
|
"example": "2026010100123456789",
|
|
3336
|
+
"format": "client-ref",
|
|
3337
|
+
"maxLength": 20,
|
|
3304
3338
|
"in": "body"
|
|
3305
3339
|
},
|
|
3306
3340
|
{
|
|
@@ -3330,6 +3364,7 @@
|
|
|
3330
3364
|
{
|
|
3331
3365
|
"name": "latlong",
|
|
3332
3366
|
"type": "string",
|
|
3367
|
+
"format": "lat-long",
|
|
3333
3368
|
"required": true,
|
|
3334
3369
|
"description": "Agent's GPS coordinates as `latitude,longitude`. Required for security and fraud prevention.",
|
|
3335
3370
|
"example": "28.6139,77.2090",
|
|
@@ -3510,8 +3545,10 @@
|
|
|
3510
3545
|
"name": "client_ref_id",
|
|
3511
3546
|
"type": "string",
|
|
3512
3547
|
"required": false,
|
|
3513
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
3548
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
3514
3549
|
"example": "2026010100123456789",
|
|
3550
|
+
"format": "client-ref",
|
|
3551
|
+
"maxLength": 20,
|
|
3515
3552
|
"in": "body"
|
|
3516
3553
|
},
|
|
3517
3554
|
{
|
|
@@ -3541,6 +3578,7 @@
|
|
|
3541
3578
|
{
|
|
3542
3579
|
"name": "latlong",
|
|
3543
3580
|
"type": "string",
|
|
3581
|
+
"format": "lat-long",
|
|
3544
3582
|
"required": true,
|
|
3545
3583
|
"description": "GPS coordinates of the agent's location at the time of daily KYC.",
|
|
3546
3584
|
"example": "28.6139,77.2090",
|
|
@@ -3736,8 +3774,10 @@
|
|
|
3736
3774
|
"name": "client_ref_id",
|
|
3737
3775
|
"type": "string",
|
|
3738
3776
|
"required": false,
|
|
3739
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
3777
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
3740
3778
|
"example": "2026010100123456789",
|
|
3779
|
+
"format": "client-ref",
|
|
3780
|
+
"maxLength": 20,
|
|
3741
3781
|
"in": "body"
|
|
3742
3782
|
},
|
|
3743
3783
|
{
|
|
@@ -3775,6 +3815,7 @@
|
|
|
3775
3815
|
{
|
|
3776
3816
|
"name": "latlong",
|
|
3777
3817
|
"type": "string",
|
|
3818
|
+
"format": "lat-long",
|
|
3778
3819
|
"required": true,
|
|
3779
3820
|
"description": "GPS coordinates of the transaction origin in 'latitude,longitude' format.",
|
|
3780
3821
|
"example": "28.6139,77.2090",
|
|
@@ -4210,8 +4251,10 @@
|
|
|
4210
4251
|
"name": "client_ref_id",
|
|
4211
4252
|
"type": "string",
|
|
4212
4253
|
"required": false,
|
|
4213
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
4254
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
4214
4255
|
"example": "2026010100123456789",
|
|
4256
|
+
"format": "client-ref",
|
|
4257
|
+
"maxLength": 20,
|
|
4215
4258
|
"in": "body"
|
|
4216
4259
|
},
|
|
4217
4260
|
{
|
|
@@ -4249,6 +4292,7 @@
|
|
|
4249
4292
|
{
|
|
4250
4293
|
"name": "latlong",
|
|
4251
4294
|
"type": "string",
|
|
4295
|
+
"format": "lat-long",
|
|
4252
4296
|
"required": true,
|
|
4253
4297
|
"description": "GPS coordinates of the transaction origin in 'latitude,longitude' format.",
|
|
4254
4298
|
"example": "28.6139,77.2090",
|
|
@@ -4560,8 +4604,10 @@
|
|
|
4560
4604
|
"name": "client_ref_id",
|
|
4561
4605
|
"type": "string",
|
|
4562
4606
|
"required": false,
|
|
4563
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
4607
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
4564
4608
|
"example": "2026010100123456789",
|
|
4609
|
+
"format": "client-ref",
|
|
4610
|
+
"maxLength": 20,
|
|
4565
4611
|
"in": "body"
|
|
4566
4612
|
},
|
|
4567
4613
|
{
|
|
@@ -4599,6 +4645,7 @@
|
|
|
4599
4645
|
{
|
|
4600
4646
|
"name": "latlong",
|
|
4601
4647
|
"type": "string",
|
|
4648
|
+
"format": "lat-long",
|
|
4602
4649
|
"required": true,
|
|
4603
4650
|
"description": "GPS coordinates of the transaction origin in 'latitude,longitude' format.",
|
|
4604
4651
|
"example": "28.6139,77.2090",
|
|
@@ -4924,8 +4971,10 @@
|
|
|
4924
4971
|
"name": "client_ref_id",
|
|
4925
4972
|
"type": "string",
|
|
4926
4973
|
"required": false,
|
|
4927
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
4974
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
4928
4975
|
"example": "2026010100123456789",
|
|
4976
|
+
"format": "client-ref",
|
|
4977
|
+
"maxLength": 20,
|
|
4929
4978
|
"in": "body"
|
|
4930
4979
|
},
|
|
4931
4980
|
{
|
|
@@ -4947,6 +4996,7 @@
|
|
|
4947
4996
|
{
|
|
4948
4997
|
"name": "ifsc",
|
|
4949
4998
|
"type": "string",
|
|
4999
|
+
"format": "ifsc",
|
|
4950
5000
|
"required": true,
|
|
4951
5001
|
"description": "IFSC code of the bank account.",
|
|
4952
5002
|
"example": "SBIN0000000",
|
|
@@ -5112,8 +5162,10 @@
|
|
|
5112
5162
|
"name": "client_ref_id",
|
|
5113
5163
|
"type": "string",
|
|
5114
5164
|
"required": false,
|
|
5115
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5165
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
5116
5166
|
"example": "2026010100123456789",
|
|
5167
|
+
"format": "client-ref",
|
|
5168
|
+
"maxLength": 20,
|
|
5117
5169
|
"in": "query"
|
|
5118
5170
|
},
|
|
5119
5171
|
{
|
|
@@ -5290,8 +5342,10 @@
|
|
|
5290
5342
|
"name": "client_ref_id",
|
|
5291
5343
|
"type": "string",
|
|
5292
5344
|
"required": false,
|
|
5293
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5345
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
5294
5346
|
"example": "2026010100123456789",
|
|
5347
|
+
"format": "client-ref",
|
|
5348
|
+
"maxLength": 20,
|
|
5295
5349
|
"in": "body"
|
|
5296
5350
|
},
|
|
5297
5351
|
{
|
|
@@ -5567,8 +5621,10 @@
|
|
|
5567
5621
|
"name": "client_ref_id",
|
|
5568
5622
|
"type": "string",
|
|
5569
5623
|
"required": false,
|
|
5570
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5624
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
5571
5625
|
"example": "2026010100123456789",
|
|
5626
|
+
"format": "client-ref",
|
|
5627
|
+
"maxLength": 20,
|
|
5572
5628
|
"in": "query"
|
|
5573
5629
|
}
|
|
5574
5630
|
],
|
|
@@ -5748,8 +5804,10 @@
|
|
|
5748
5804
|
"name": "client_ref_id",
|
|
5749
5805
|
"type": "string",
|
|
5750
5806
|
"required": false,
|
|
5751
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5807
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
5752
5808
|
"example": "2026010100123456789",
|
|
5809
|
+
"format": "client-ref",
|
|
5810
|
+
"maxLength": 20,
|
|
5753
5811
|
"in": "query"
|
|
5754
5812
|
}
|
|
5755
5813
|
],
|
|
@@ -5914,8 +5972,10 @@
|
|
|
5914
5972
|
"name": "client_ref_id",
|
|
5915
5973
|
"type": "string",
|
|
5916
5974
|
"required": false,
|
|
5917
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5975
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
5918
5976
|
"example": "2026010100123456789",
|
|
5977
|
+
"format": "client-ref",
|
|
5978
|
+
"maxLength": 20,
|
|
5919
5979
|
"in": "query"
|
|
5920
5980
|
},
|
|
5921
5981
|
{
|
|
@@ -6141,8 +6201,10 @@
|
|
|
6141
6201
|
"name": "client_ref_id",
|
|
6142
6202
|
"type": "string",
|
|
6143
6203
|
"required": false,
|
|
6144
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6204
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
6145
6205
|
"example": "2026010100123456789",
|
|
6206
|
+
"format": "client-ref",
|
|
6207
|
+
"maxLength": 20,
|
|
6146
6208
|
"in": "query"
|
|
6147
6209
|
},
|
|
6148
6210
|
{
|
|
@@ -6363,8 +6425,10 @@
|
|
|
6363
6425
|
"name": "client_ref_id",
|
|
6364
6426
|
"type": "string",
|
|
6365
6427
|
"required": false,
|
|
6366
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6428
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
6367
6429
|
"example": "2026010100123456789",
|
|
6430
|
+
"format": "client-ref",
|
|
6431
|
+
"maxLength": 20,
|
|
6368
6432
|
"in": "query"
|
|
6369
6433
|
}
|
|
6370
6434
|
],
|
|
@@ -6539,8 +6603,10 @@
|
|
|
6539
6603
|
"name": "client_ref_id",
|
|
6540
6604
|
"type": "string",
|
|
6541
6605
|
"required": false,
|
|
6542
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6606
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
6543
6607
|
"example": "2026010100123456789",
|
|
6608
|
+
"format": "client-ref",
|
|
6609
|
+
"maxLength": 20,
|
|
6544
6610
|
"in": "query"
|
|
6545
6611
|
},
|
|
6546
6612
|
{
|
|
@@ -6691,8 +6757,10 @@
|
|
|
6691
6757
|
"name": "client_ref_id",
|
|
6692
6758
|
"type": "string",
|
|
6693
6759
|
"required": false,
|
|
6694
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6760
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
6695
6761
|
"example": "2026010100123456789",
|
|
6762
|
+
"format": "client-ref",
|
|
6763
|
+
"maxLength": 20,
|
|
6696
6764
|
"in": "query"
|
|
6697
6765
|
},
|
|
6698
6766
|
{
|
|
@@ -7611,14 +7679,17 @@
|
|
|
7611
7679
|
"name": "client_ref_id",
|
|
7612
7680
|
"type": "string",
|
|
7613
7681
|
"required": false,
|
|
7614
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
7682
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
7615
7683
|
"example": "2026010100123456789",
|
|
7684
|
+
"format": "client-ref",
|
|
7685
|
+
"maxLength": 20,
|
|
7616
7686
|
"in": "body"
|
|
7617
7687
|
},
|
|
7618
7688
|
{
|
|
7619
7689
|
"name": "pan_number",
|
|
7620
7690
|
"label": "PAN Number",
|
|
7621
7691
|
"type": "string",
|
|
7692
|
+
"format": "pan",
|
|
7622
7693
|
"required": true,
|
|
7623
7694
|
"description": "10-character alphanumeric PAN identifier (5 letters, 4 digits, 1 letter).",
|
|
7624
7695
|
"example": "GGTPB7880Q",
|
|
@@ -7782,14 +7853,17 @@
|
|
|
7782
7853
|
"name": "client_ref_id",
|
|
7783
7854
|
"type": "string",
|
|
7784
7855
|
"required": false,
|
|
7785
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
7856
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
7786
7857
|
"example": "2026010100123456789",
|
|
7858
|
+
"format": "client-ref",
|
|
7859
|
+
"maxLength": 20,
|
|
7787
7860
|
"in": "body"
|
|
7788
7861
|
},
|
|
7789
7862
|
{
|
|
7790
7863
|
"name": "pan_number",
|
|
7791
7864
|
"label": "PAN Number",
|
|
7792
7865
|
"type": "string",
|
|
7866
|
+
"format": "pan",
|
|
7793
7867
|
"required": true,
|
|
7794
7868
|
"description": "10-character alphanumeric PAN identifier (5 letters, 4 digits, 1 letter).",
|
|
7795
7869
|
"example": "ABCDE1234F",
|
|
@@ -7807,6 +7881,7 @@
|
|
|
7807
7881
|
"name": "dob",
|
|
7808
7882
|
"label": "Date of Birth",
|
|
7809
7883
|
"type": "string",
|
|
7884
|
+
"format": "date",
|
|
7810
7885
|
"required": true,
|
|
7811
7886
|
"description": "Date of birth in YYYY-MM-DD format.",
|
|
7812
7887
|
"example": "1994-08-29",
|
|
@@ -8023,14 +8098,17 @@
|
|
|
8023
8098
|
"name": "client_ref_id",
|
|
8024
8099
|
"type": "string",
|
|
8025
8100
|
"required": false,
|
|
8026
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8101
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
8027
8102
|
"example": "2026010100123456789",
|
|
8103
|
+
"format": "client-ref",
|
|
8104
|
+
"maxLength": 20,
|
|
8028
8105
|
"in": "body"
|
|
8029
8106
|
},
|
|
8030
8107
|
{
|
|
8031
8108
|
"name": "pan",
|
|
8032
8109
|
"label": "PAN Number",
|
|
8033
8110
|
"type": "string",
|
|
8111
|
+
"format": "pan",
|
|
8034
8112
|
"required": true,
|
|
8035
8113
|
"description": "10-character alphanumeric PAN identifier (first 5 alphabets, 4 digits, 1 alphabet).",
|
|
8036
8114
|
"example": "ABCDE1234F",
|
|
@@ -8326,8 +8404,10 @@
|
|
|
8326
8404
|
"name": "client_ref_id",
|
|
8327
8405
|
"type": "string",
|
|
8328
8406
|
"required": false,
|
|
8329
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8407
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
8330
8408
|
"example": "2026010100123456789",
|
|
8409
|
+
"format": "client-ref",
|
|
8410
|
+
"maxLength": 20,
|
|
8331
8411
|
"in": "body"
|
|
8332
8412
|
},
|
|
8333
8413
|
{
|
|
@@ -8491,8 +8571,10 @@
|
|
|
8491
8571
|
"name": "client_ref_id",
|
|
8492
8572
|
"type": "string",
|
|
8493
8573
|
"required": false,
|
|
8494
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8574
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
8495
8575
|
"example": "2026010100123456789",
|
|
8576
|
+
"format": "client-ref",
|
|
8577
|
+
"maxLength": 20,
|
|
8496
8578
|
"in": "query"
|
|
8497
8579
|
},
|
|
8498
8580
|
{
|
|
@@ -8742,8 +8824,10 @@
|
|
|
8742
8824
|
"name": "client_ref_id",
|
|
8743
8825
|
"type": "string",
|
|
8744
8826
|
"required": false,
|
|
8745
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8827
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
8746
8828
|
"example": "2026010100123456789",
|
|
8829
|
+
"format": "client-ref",
|
|
8830
|
+
"maxLength": 20,
|
|
8747
8831
|
"in": "body"
|
|
8748
8832
|
},
|
|
8749
8833
|
{
|
|
@@ -8757,6 +8841,7 @@
|
|
|
8757
8841
|
{
|
|
8758
8842
|
"name": "aadhar",
|
|
8759
8843
|
"type": "string",
|
|
8844
|
+
"format": "aadhaar",
|
|
8760
8845
|
"required": true,
|
|
8761
8846
|
"description": "12-digit Aadhaar number of the sender.",
|
|
8762
8847
|
"example": "123456789012",
|
|
@@ -8913,8 +8998,10 @@
|
|
|
8913
8998
|
"name": "client_ref_id",
|
|
8914
8999
|
"type": "string",
|
|
8915
9000
|
"required": false,
|
|
8916
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9001
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
8917
9002
|
"example": "2026010100123456789",
|
|
9003
|
+
"format": "client-ref",
|
|
9004
|
+
"maxLength": 20,
|
|
8918
9005
|
"in": "body"
|
|
8919
9006
|
},
|
|
8920
9007
|
{
|
|
@@ -9128,8 +9215,10 @@
|
|
|
9128
9215
|
"name": "client_ref_id",
|
|
9129
9216
|
"type": "string",
|
|
9130
9217
|
"required": false,
|
|
9131
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9218
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
9132
9219
|
"example": "2026010100123456789",
|
|
9220
|
+
"format": "client-ref",
|
|
9221
|
+
"maxLength": 20,
|
|
9133
9222
|
"in": "query"
|
|
9134
9223
|
},
|
|
9135
9224
|
{
|
|
@@ -9280,8 +9369,10 @@
|
|
|
9280
9369
|
"name": "client_ref_id",
|
|
9281
9370
|
"type": "string",
|
|
9282
9371
|
"required": false,
|
|
9283
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9372
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
9284
9373
|
"example": "2026010100123456789",
|
|
9374
|
+
"format": "client-ref",
|
|
9375
|
+
"maxLength": 20,
|
|
9285
9376
|
"in": "body"
|
|
9286
9377
|
},
|
|
9287
9378
|
{
|
|
@@ -9303,6 +9394,7 @@
|
|
|
9303
9394
|
{
|
|
9304
9395
|
"name": "dob",
|
|
9305
9396
|
"type": "string",
|
|
9397
|
+
"format": "date",
|
|
9306
9398
|
"required": true,
|
|
9307
9399
|
"description": "Date of birth of the sender in YYYY-MM-DD format.",
|
|
9308
9400
|
"example": "1990-05-15",
|
|
@@ -9466,8 +9558,10 @@
|
|
|
9466
9558
|
"name": "client_ref_id",
|
|
9467
9559
|
"type": "string",
|
|
9468
9560
|
"required": false,
|
|
9469
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9561
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
9470
9562
|
"example": "2026010100123456789",
|
|
9563
|
+
"format": "client-ref",
|
|
9564
|
+
"maxLength": 20,
|
|
9471
9565
|
"in": "body"
|
|
9472
9566
|
},
|
|
9473
9567
|
{
|
|
@@ -9784,8 +9878,10 @@
|
|
|
9784
9878
|
"name": "client_ref_id",
|
|
9785
9879
|
"type": "string",
|
|
9786
9880
|
"required": false,
|
|
9787
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9881
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
9788
9882
|
"example": "2026010100123456789",
|
|
9883
|
+
"format": "client-ref",
|
|
9884
|
+
"maxLength": 20,
|
|
9789
9885
|
"in": "body"
|
|
9790
9886
|
},
|
|
9791
9887
|
{
|
|
@@ -9799,6 +9895,7 @@
|
|
|
9799
9895
|
{
|
|
9800
9896
|
"name": "pan_number",
|
|
9801
9897
|
"type": "string",
|
|
9898
|
+
"format": "pan",
|
|
9802
9899
|
"required": false,
|
|
9803
9900
|
"description": "The PAN number of the sender.",
|
|
9804
9901
|
"example": "ABCDE1234F",
|
|
@@ -10008,8 +10105,10 @@
|
|
|
10008
10105
|
"name": "client_ref_id",
|
|
10009
10106
|
"type": "string",
|
|
10010
10107
|
"required": false,
|
|
10011
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10108
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
10012
10109
|
"example": "2026010100123456789",
|
|
10110
|
+
"format": "client-ref",
|
|
10111
|
+
"maxLength": 20,
|
|
10013
10112
|
"in": "query"
|
|
10014
10113
|
},
|
|
10015
10114
|
{
|
|
@@ -10262,8 +10361,10 @@
|
|
|
10262
10361
|
"name": "client_ref_id",
|
|
10263
10362
|
"type": "string",
|
|
10264
10363
|
"required": false,
|
|
10265
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10364
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
10266
10365
|
"example": "2026010100123456789",
|
|
10366
|
+
"format": "client-ref",
|
|
10367
|
+
"maxLength": 20,
|
|
10267
10368
|
"in": "body"
|
|
10268
10369
|
},
|
|
10269
10370
|
{
|
|
@@ -10317,6 +10418,7 @@
|
|
|
10317
10418
|
{
|
|
10318
10419
|
"name": "ifsc",
|
|
10319
10420
|
"type": "string",
|
|
10421
|
+
"format": "ifsc",
|
|
10320
10422
|
"required": true,
|
|
10321
10423
|
"description": "IFSC code of the recipient's bank branch.",
|
|
10322
10424
|
"example": "KKBK0000878",
|
|
@@ -10477,8 +10579,10 @@
|
|
|
10477
10579
|
"name": "client_ref_id",
|
|
10478
10580
|
"type": "string",
|
|
10479
10581
|
"required": false,
|
|
10480
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10582
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
10481
10583
|
"example": "2026010100123456789",
|
|
10584
|
+
"format": "client-ref",
|
|
10585
|
+
"maxLength": 20,
|
|
10482
10586
|
"in": "body"
|
|
10483
10587
|
},
|
|
10484
10588
|
{
|
|
@@ -10625,8 +10729,10 @@
|
|
|
10625
10729
|
"name": "client_ref_id",
|
|
10626
10730
|
"type": "string",
|
|
10627
10731
|
"required": false,
|
|
10628
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10732
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
10629
10733
|
"example": "2026010100123456789",
|
|
10734
|
+
"format": "client-ref",
|
|
10735
|
+
"maxLength": 20,
|
|
10630
10736
|
"in": "body"
|
|
10631
10737
|
},
|
|
10632
10738
|
{
|
|
@@ -10789,8 +10895,10 @@
|
|
|
10789
10895
|
"name": "client_ref_id",
|
|
10790
10896
|
"type": "string",
|
|
10791
10897
|
"required": false,
|
|
10792
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10898
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
10793
10899
|
"example": "2026010100123456789",
|
|
10900
|
+
"format": "client-ref",
|
|
10901
|
+
"maxLength": 20,
|
|
10794
10902
|
"in": "body"
|
|
10795
10903
|
},
|
|
10796
10904
|
{
|
|
@@ -10868,6 +10976,7 @@
|
|
|
10868
10976
|
{
|
|
10869
10977
|
"name": "latlong",
|
|
10870
10978
|
"type": "string",
|
|
10979
|
+
"format": "lat-long",
|
|
10871
10980
|
"required": false,
|
|
10872
10981
|
"description": "Geographic coordinates of the user's location.",
|
|
10873
10982
|
"example": "28.63,77.22",
|
|
@@ -11129,8 +11238,10 @@
|
|
|
11129
11238
|
"name": "client_ref_id",
|
|
11130
11239
|
"type": "string",
|
|
11131
11240
|
"required": false,
|
|
11132
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11241
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
11133
11242
|
"example": "2026010100123456789",
|
|
11243
|
+
"format": "client-ref",
|
|
11244
|
+
"maxLength": 20,
|
|
11134
11245
|
"in": "query"
|
|
11135
11246
|
},
|
|
11136
11247
|
{
|
|
@@ -11281,8 +11392,10 @@
|
|
|
11281
11392
|
"name": "client_ref_id",
|
|
11282
11393
|
"type": "string",
|
|
11283
11394
|
"required": false,
|
|
11284
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11395
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
11285
11396
|
"example": "2026010100123456789",
|
|
11397
|
+
"format": "client-ref",
|
|
11398
|
+
"maxLength": 20,
|
|
11286
11399
|
"in": "body"
|
|
11287
11400
|
},
|
|
11288
11401
|
{
|
|
@@ -11304,6 +11417,7 @@
|
|
|
11304
11417
|
{
|
|
11305
11418
|
"name": "dob",
|
|
11306
11419
|
"type": "string",
|
|
11420
|
+
"format": "date",
|
|
11307
11421
|
"required": true,
|
|
11308
11422
|
"description": "Date of birth of the sender in YYYY-MM-DD format.",
|
|
11309
11423
|
"example": "1990-05-15",
|
|
@@ -11475,8 +11589,10 @@
|
|
|
11475
11589
|
"name": "client_ref_id",
|
|
11476
11590
|
"type": "string",
|
|
11477
11591
|
"required": false,
|
|
11478
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11592
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
11479
11593
|
"example": "2026010100123456789",
|
|
11594
|
+
"format": "client-ref",
|
|
11595
|
+
"maxLength": 20,
|
|
11480
11596
|
"in": "body"
|
|
11481
11597
|
},
|
|
11482
11598
|
{
|
|
@@ -11609,8 +11725,10 @@
|
|
|
11609
11725
|
"name": "client_ref_id",
|
|
11610
11726
|
"type": "string",
|
|
11611
11727
|
"required": false,
|
|
11612
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11728
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
11613
11729
|
"example": "2026010100123456789",
|
|
11730
|
+
"format": "client-ref",
|
|
11731
|
+
"maxLength": 20,
|
|
11614
11732
|
"in": "body"
|
|
11615
11733
|
},
|
|
11616
11734
|
{
|
|
@@ -12228,8 +12346,10 @@
|
|
|
12228
12346
|
"name": "client_ref_id",
|
|
12229
12347
|
"type": "string",
|
|
12230
12348
|
"required": false,
|
|
12231
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12349
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
12232
12350
|
"example": "2026010100123456789",
|
|
12351
|
+
"format": "client-ref",
|
|
12352
|
+
"maxLength": 20,
|
|
12233
12353
|
"in": "body"
|
|
12234
12354
|
},
|
|
12235
12355
|
{
|
|
@@ -12243,6 +12363,7 @@
|
|
|
12243
12363
|
{
|
|
12244
12364
|
"name": "aadhar",
|
|
12245
12365
|
"type": "string",
|
|
12366
|
+
"format": "aadhaar",
|
|
12246
12367
|
"required": true,
|
|
12247
12368
|
"description": "12-digit Aadhaar number of the sender.",
|
|
12248
12369
|
"example": "123456789012",
|
|
@@ -12371,8 +12492,10 @@
|
|
|
12371
12492
|
"name": "client_ref_id",
|
|
12372
12493
|
"type": "string",
|
|
12373
12494
|
"required": false,
|
|
12374
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12495
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
12375
12496
|
"example": "2026010100123456789",
|
|
12497
|
+
"format": "client-ref",
|
|
12498
|
+
"maxLength": 20,
|
|
12376
12499
|
"in": "body"
|
|
12377
12500
|
},
|
|
12378
12501
|
{
|
|
@@ -12514,8 +12637,10 @@
|
|
|
12514
12637
|
"name": "client_ref_id",
|
|
12515
12638
|
"type": "string",
|
|
12516
12639
|
"required": false,
|
|
12517
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12640
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
12518
12641
|
"example": "2026010100123456789",
|
|
12642
|
+
"format": "client-ref",
|
|
12643
|
+
"maxLength": 20,
|
|
12519
12644
|
"in": "body"
|
|
12520
12645
|
},
|
|
12521
12646
|
{
|
|
@@ -12529,6 +12654,7 @@
|
|
|
12529
12654
|
{
|
|
12530
12655
|
"name": "pan_number",
|
|
12531
12656
|
"type": "string",
|
|
12657
|
+
"format": "pan",
|
|
12532
12658
|
"required": true,
|
|
12533
12659
|
"description": "The PAN number of the sender.",
|
|
12534
12660
|
"example": "ABCDE1234F",
|
|
@@ -12708,8 +12834,10 @@
|
|
|
12708
12834
|
"name": "client_ref_id",
|
|
12709
12835
|
"type": "string",
|
|
12710
12836
|
"required": false,
|
|
12711
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12837
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
12712
12838
|
"example": "2026010100123456789",
|
|
12839
|
+
"format": "client-ref",
|
|
12840
|
+
"maxLength": 20,
|
|
12713
12841
|
"in": "body"
|
|
12714
12842
|
},
|
|
12715
12843
|
{
|
|
@@ -12862,8 +12990,10 @@
|
|
|
12862
12990
|
"name": "client_ref_id",
|
|
12863
12991
|
"type": "string",
|
|
12864
12992
|
"required": false,
|
|
12865
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12993
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
12866
12994
|
"example": "2026010100123456789",
|
|
12995
|
+
"format": "client-ref",
|
|
12996
|
+
"maxLength": 20,
|
|
12867
12997
|
"in": "query"
|
|
12868
12998
|
},
|
|
12869
12999
|
{
|
|
@@ -13096,8 +13226,10 @@
|
|
|
13096
13226
|
"name": "client_ref_id",
|
|
13097
13227
|
"type": "string",
|
|
13098
13228
|
"required": false,
|
|
13099
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13229
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
13100
13230
|
"example": "2026010100123456789",
|
|
13231
|
+
"format": "client-ref",
|
|
13232
|
+
"maxLength": 20,
|
|
13101
13233
|
"in": "body"
|
|
13102
13234
|
},
|
|
13103
13235
|
{
|
|
@@ -13278,8 +13410,10 @@
|
|
|
13278
13410
|
"name": "client_ref_id",
|
|
13279
13411
|
"type": "string",
|
|
13280
13412
|
"required": false,
|
|
13281
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13413
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
13282
13414
|
"example": "2026010100123456789",
|
|
13415
|
+
"format": "client-ref",
|
|
13416
|
+
"maxLength": 20,
|
|
13283
13417
|
"in": "body"
|
|
13284
13418
|
},
|
|
13285
13419
|
{
|
|
@@ -13425,8 +13559,10 @@
|
|
|
13425
13559
|
"name": "client_ref_id",
|
|
13426
13560
|
"type": "string",
|
|
13427
13561
|
"required": false,
|
|
13428
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13562
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
13429
13563
|
"example": "2026010100123456789",
|
|
13564
|
+
"format": "client-ref",
|
|
13565
|
+
"maxLength": 20,
|
|
13430
13566
|
"in": "body"
|
|
13431
13567
|
},
|
|
13432
13568
|
{
|
|
@@ -13568,8 +13704,10 @@
|
|
|
13568
13704
|
"name": "client_ref_id",
|
|
13569
13705
|
"type": "string",
|
|
13570
13706
|
"required": false,
|
|
13571
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13707
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
13572
13708
|
"example": "2026010100123456789",
|
|
13709
|
+
"format": "client-ref",
|
|
13710
|
+
"maxLength": 20,
|
|
13573
13711
|
"in": "body"
|
|
13574
13712
|
},
|
|
13575
13713
|
{
|
|
@@ -13732,8 +13870,10 @@
|
|
|
13732
13870
|
"name": "client_ref_id",
|
|
13733
13871
|
"type": "string",
|
|
13734
13872
|
"required": false,
|
|
13735
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13873
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
13736
13874
|
"example": "2026010100123456789",
|
|
13875
|
+
"format": "client-ref",
|
|
13876
|
+
"maxLength": 20,
|
|
13737
13877
|
"in": "body"
|
|
13738
13878
|
},
|
|
13739
13879
|
{
|
|
@@ -13819,6 +13959,7 @@
|
|
|
13819
13959
|
{
|
|
13820
13960
|
"name": "latlong",
|
|
13821
13961
|
"type": "string",
|
|
13962
|
+
"format": "lat-long",
|
|
13822
13963
|
"required": false,
|
|
13823
13964
|
"description": "Geographic coordinates of the user's location.",
|
|
13824
13965
|
"example": "28.63,77.22",
|
|
@@ -14066,13 +14207,16 @@
|
|
|
14066
14207
|
"name": "client_ref_id",
|
|
14067
14208
|
"type": "string",
|
|
14068
14209
|
"required": false,
|
|
14069
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14210
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
14070
14211
|
"example": "2026010100123456789",
|
|
14212
|
+
"format": "client-ref",
|
|
14213
|
+
"maxLength": 20,
|
|
14071
14214
|
"in": "body"
|
|
14072
14215
|
},
|
|
14073
14216
|
{
|
|
14074
14217
|
"name": "pan_number",
|
|
14075
14218
|
"type": "string",
|
|
14219
|
+
"format": "pan",
|
|
14076
14220
|
"required": true,
|
|
14077
14221
|
"description": "PAN card number of the agent.",
|
|
14078
14222
|
"example": "ABCDE1234F",
|
|
@@ -14128,6 +14272,7 @@
|
|
|
14128
14272
|
{
|
|
14129
14273
|
"name": "dob",
|
|
14130
14274
|
"type": "string",
|
|
14275
|
+
"format": "date",
|
|
14131
14276
|
"required": true,
|
|
14132
14277
|
"description": "Date of birth of the agent in YYYY-MM-DD format.",
|
|
14133
14278
|
"example": "1990-05-15",
|
|
@@ -14277,8 +14422,10 @@
|
|
|
14277
14422
|
"name": "client_ref_id",
|
|
14278
14423
|
"type": "string",
|
|
14279
14424
|
"required": false,
|
|
14280
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14425
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
14281
14426
|
"example": "2026010100123456789",
|
|
14427
|
+
"format": "client-ref",
|
|
14428
|
+
"maxLength": 20,
|
|
14282
14429
|
"in": "body"
|
|
14283
14430
|
},
|
|
14284
14431
|
{
|
|
@@ -14401,8 +14548,10 @@
|
|
|
14401
14548
|
"name": "client_ref_id",
|
|
14402
14549
|
"type": "string",
|
|
14403
14550
|
"required": false,
|
|
14404
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14551
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
14405
14552
|
"example": "2026010100123456789",
|
|
14553
|
+
"format": "client-ref",
|
|
14554
|
+
"maxLength": 20,
|
|
14406
14555
|
"in": "body"
|
|
14407
14556
|
},
|
|
14408
14557
|
{
|
|
@@ -14525,8 +14674,10 @@
|
|
|
14525
14674
|
"name": "client_ref_id",
|
|
14526
14675
|
"type": "string",
|
|
14527
14676
|
"required": false,
|
|
14528
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14677
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
14529
14678
|
"example": "2026010100123456789",
|
|
14679
|
+
"format": "client-ref",
|
|
14680
|
+
"maxLength": 20,
|
|
14530
14681
|
"in": "query"
|
|
14531
14682
|
},
|
|
14532
14683
|
{
|
|
@@ -14720,8 +14871,10 @@
|
|
|
14720
14871
|
"name": "client_ref_id",
|
|
14721
14872
|
"type": "string",
|
|
14722
14873
|
"required": false,
|
|
14723
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14874
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
14724
14875
|
"example": "2026010100123456789",
|
|
14876
|
+
"format": "client-ref",
|
|
14877
|
+
"maxLength": 20,
|
|
14725
14878
|
"in": "query"
|
|
14726
14879
|
}
|
|
14727
14880
|
],
|
|
@@ -14877,8 +15030,10 @@
|
|
|
14877
15030
|
"name": "client_ref_id",
|
|
14878
15031
|
"type": "string",
|
|
14879
15032
|
"required": false,
|
|
14880
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15033
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
14881
15034
|
"example": "2026010100123456789",
|
|
15035
|
+
"format": "client-ref",
|
|
15036
|
+
"maxLength": 20,
|
|
14882
15037
|
"in": "query"
|
|
14883
15038
|
},
|
|
14884
15039
|
{
|
|
@@ -15023,8 +15178,10 @@
|
|
|
15023
15178
|
"name": "client_ref_id",
|
|
15024
15179
|
"type": "string",
|
|
15025
15180
|
"required": false,
|
|
15026
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15181
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
15027
15182
|
"example": "2026010100123456789",
|
|
15183
|
+
"format": "client-ref",
|
|
15184
|
+
"maxLength": 20,
|
|
15028
15185
|
"in": "query"
|
|
15029
15186
|
},
|
|
15030
15187
|
{
|
|
@@ -15528,8 +15685,10 @@
|
|
|
15528
15685
|
"name": "client_ref_id",
|
|
15529
15686
|
"type": "string",
|
|
15530
15687
|
"required": false,
|
|
15531
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15688
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
15532
15689
|
"example": "2026010100123456789",
|
|
15690
|
+
"format": "client-ref",
|
|
15691
|
+
"maxLength": 20,
|
|
15533
15692
|
"in": "query"
|
|
15534
15693
|
}
|
|
15535
15694
|
],
|
|
@@ -15627,8 +15786,10 @@
|
|
|
15627
15786
|
"name": "client_ref_id",
|
|
15628
15787
|
"type": "string",
|
|
15629
15788
|
"required": false,
|
|
15630
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15789
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
15631
15790
|
"example": "2026010100123456789",
|
|
15791
|
+
"format": "client-ref",
|
|
15792
|
+
"maxLength": 20,
|
|
15632
15793
|
"in": "query"
|
|
15633
15794
|
},
|
|
15634
15795
|
{
|
|
@@ -15642,6 +15803,7 @@
|
|
|
15642
15803
|
{
|
|
15643
15804
|
"name": "ifsc",
|
|
15644
15805
|
"type": "string",
|
|
15806
|
+
"format": "ifsc",
|
|
15645
15807
|
"required": false,
|
|
15646
15808
|
"description": "IFSC code to narrow the lookup.",
|
|
15647
15809
|
"example": "IDFB0080202",
|
|
@@ -15800,13 +15962,16 @@
|
|
|
15800
15962
|
"name": "client_ref_id",
|
|
15801
15963
|
"type": "string",
|
|
15802
15964
|
"required": false,
|
|
15803
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15965
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
15804
15966
|
"example": "2026010100123456789",
|
|
15967
|
+
"format": "client-ref",
|
|
15968
|
+
"maxLength": 20,
|
|
15805
15969
|
"in": "query"
|
|
15806
15970
|
},
|
|
15807
15971
|
{
|
|
15808
15972
|
"name": "ifsc",
|
|
15809
15973
|
"type": "string",
|
|
15974
|
+
"format": "ifsc",
|
|
15810
15975
|
"required": true,
|
|
15811
15976
|
"description": "IFSC code of the bank branch.",
|
|
15812
15977
|
"example": "IOBA0002248",
|
|
@@ -15955,8 +16120,10 @@
|
|
|
15955
16120
|
"name": "client_ref_id",
|
|
15956
16121
|
"type": "string",
|
|
15957
16122
|
"required": false,
|
|
15958
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16123
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
15959
16124
|
"example": "2026010100123456789",
|
|
16125
|
+
"format": "client-ref",
|
|
16126
|
+
"maxLength": 20,
|
|
15960
16127
|
"in": "body"
|
|
15961
16128
|
},
|
|
15962
16129
|
{
|
|
@@ -16136,8 +16303,10 @@
|
|
|
16136
16303
|
"name": "client_ref_id",
|
|
16137
16304
|
"type": "string",
|
|
16138
16305
|
"required": false,
|
|
16139
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16306
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
16140
16307
|
"example": "2026010100123456789",
|
|
16308
|
+
"format": "client-ref",
|
|
16309
|
+
"maxLength": 20,
|
|
16141
16310
|
"in": "body"
|
|
16142
16311
|
},
|
|
16143
16312
|
{
|
|
@@ -16433,8 +16602,10 @@
|
|
|
16433
16602
|
"name": "client_ref_id",
|
|
16434
16603
|
"type": "string",
|
|
16435
16604
|
"required": false,
|
|
16436
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16605
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
16437
16606
|
"example": "2026010100123456789",
|
|
16607
|
+
"format": "client-ref",
|
|
16608
|
+
"maxLength": 20,
|
|
16438
16609
|
"in": "query"
|
|
16439
16610
|
},
|
|
16440
16611
|
{
|
|
@@ -16647,8 +16818,10 @@
|
|
|
16647
16818
|
"name": "client_ref_id",
|
|
16648
16819
|
"type": "string",
|
|
16649
16820
|
"required": false,
|
|
16650
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16821
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
16651
16822
|
"example": "2026010100123456789",
|
|
16823
|
+
"format": "client-ref",
|
|
16824
|
+
"maxLength": 20,
|
|
16652
16825
|
"in": "body"
|
|
16653
16826
|
},
|
|
16654
16827
|
{
|
|
@@ -16656,24 +16829,25 @@
|
|
|
16656
16829
|
"type": "number",
|
|
16657
16830
|
"required": true,
|
|
16658
16831
|
"description": "Complete bank account number to be verified.",
|
|
16659
|
-
"example":
|
|
16832
|
+
"example": "026291800001191",
|
|
16660
16833
|
"in": "body"
|
|
16661
16834
|
},
|
|
16662
16835
|
{
|
|
16663
16836
|
"name": "ifsc",
|
|
16664
16837
|
"label": "IFSC Code",
|
|
16665
16838
|
"type": "string",
|
|
16839
|
+
"format": "ifsc",
|
|
16666
16840
|
"required": true,
|
|
16667
16841
|
"description": "IFSC code of the bank account to be verified (11-character alphanumeric).",
|
|
16668
|
-
"example": "
|
|
16842
|
+
"example": "YESB0000262",
|
|
16669
16843
|
"in": "body"
|
|
16670
16844
|
}
|
|
16671
16845
|
],
|
|
16672
16846
|
"sampleRequest": {
|
|
16673
16847
|
"initiator_id": "9962981729",
|
|
16674
16848
|
"client_ref_id": "2026010100123456789",
|
|
16675
|
-
"bank_account":
|
|
16676
|
-
"ifsc": "
|
|
16849
|
+
"bank_account": "026291800001191",
|
|
16850
|
+
"ifsc": "YESB0000262"
|
|
16677
16851
|
},
|
|
16678
16852
|
"responseFields": [
|
|
16679
16853
|
{
|
|
@@ -16882,8 +17056,10 @@
|
|
|
16882
17056
|
"name": "client_ref_id",
|
|
16883
17057
|
"type": "string",
|
|
16884
17058
|
"required": false,
|
|
16885
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17059
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
16886
17060
|
"example": "2026010100123456789",
|
|
17061
|
+
"format": "client-ref",
|
|
17062
|
+
"maxLength": 20,
|
|
16887
17063
|
"in": "body"
|
|
16888
17064
|
},
|
|
16889
17065
|
{
|
|
@@ -16899,6 +17075,7 @@
|
|
|
16899
17075
|
"name": "ifsc",
|
|
16900
17076
|
"label": "IFSC Code",
|
|
16901
17077
|
"type": "string",
|
|
17078
|
+
"format": "ifsc",
|
|
16902
17079
|
"required": true,
|
|
16903
17080
|
"description": "IFSC code of the bank account to be verified (11-character alphanumeric).",
|
|
16904
17081
|
"example": "SBIN0007515",
|
|
@@ -17052,8 +17229,10 @@
|
|
|
17052
17229
|
"name": "client_ref_id",
|
|
17053
17230
|
"type": "string",
|
|
17054
17231
|
"required": false,
|
|
17055
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17232
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
17056
17233
|
"example": "2026010100123456789",
|
|
17234
|
+
"format": "client-ref",
|
|
17235
|
+
"maxLength": 20,
|
|
17057
17236
|
"in": "body"
|
|
17058
17237
|
},
|
|
17059
17238
|
{
|
|
@@ -17256,8 +17435,10 @@
|
|
|
17256
17435
|
"name": "client_ref_id",
|
|
17257
17436
|
"type": "string",
|
|
17258
17437
|
"required": false,
|
|
17259
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17438
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
17260
17439
|
"example": "2026010100123456789",
|
|
17440
|
+
"format": "client-ref",
|
|
17441
|
+
"maxLength": 20,
|
|
17261
17442
|
"in": "query"
|
|
17262
17443
|
},
|
|
17263
17444
|
{
|
|
@@ -17482,8 +17663,10 @@
|
|
|
17482
17663
|
"name": "client_ref_id",
|
|
17483
17664
|
"type": "string",
|
|
17484
17665
|
"required": false,
|
|
17485
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17666
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
17486
17667
|
"example": "2026010100123456789",
|
|
17668
|
+
"format": "client-ref",
|
|
17669
|
+
"maxLength": 20,
|
|
17487
17670
|
"in": "body"
|
|
17488
17671
|
},
|
|
17489
17672
|
{
|
|
@@ -17902,13 +18085,16 @@
|
|
|
17902
18085
|
"name": "client_ref_id",
|
|
17903
18086
|
"type": "string",
|
|
17904
18087
|
"required": false,
|
|
17905
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
18088
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
17906
18089
|
"example": "2026010100123456789",
|
|
18090
|
+
"format": "client-ref",
|
|
18091
|
+
"maxLength": 20,
|
|
17907
18092
|
"in": "body"
|
|
17908
18093
|
},
|
|
17909
18094
|
{
|
|
17910
18095
|
"name": "pan",
|
|
17911
18096
|
"type": "string",
|
|
18097
|
+
"format": "pan",
|
|
17912
18098
|
"required": true,
|
|
17913
18099
|
"description": "10-character alphanumeric PAN of the business or individual (5 letters, 4 digits, 1 letter).",
|
|
17914
18100
|
"example": "ABCDE1234F",
|
|
@@ -18111,8 +18297,10 @@
|
|
|
18111
18297
|
"name": "client_ref_id",
|
|
18112
18298
|
"type": "string",
|
|
18113
18299
|
"required": false,
|
|
18114
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
18300
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
18115
18301
|
"example": "2026010100123456789",
|
|
18302
|
+
"format": "client-ref",
|
|
18303
|
+
"maxLength": 20,
|
|
18116
18304
|
"in": "body"
|
|
18117
18305
|
},
|
|
18118
18306
|
{
|
|
@@ -18143,6 +18331,7 @@
|
|
|
18143
18331
|
{
|
|
18144
18332
|
"name": "latlong",
|
|
18145
18333
|
"type": "string",
|
|
18334
|
+
"format": "lat-long",
|
|
18146
18335
|
"required": true,
|
|
18147
18336
|
"description": "Geo-coordinates of the request origination point (latitude,longitude).",
|
|
18148
18337
|
"example": "28.6139,77.2090",
|
|
@@ -18338,8 +18527,10 @@
|
|
|
18338
18527
|
"name": "client_ref_id",
|
|
18339
18528
|
"type": "string",
|
|
18340
18529
|
"required": false,
|
|
18341
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
18530
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
18342
18531
|
"example": "2026010100123456789",
|
|
18532
|
+
"format": "client-ref",
|
|
18533
|
+
"maxLength": 20,
|
|
18343
18534
|
"in": "body"
|
|
18344
18535
|
},
|
|
18345
18536
|
{
|
|
@@ -18353,6 +18544,7 @@
|
|
|
18353
18544
|
{
|
|
18354
18545
|
"name": "dob",
|
|
18355
18546
|
"type": "string",
|
|
18547
|
+
"format": "date",
|
|
18356
18548
|
"required": true,
|
|
18357
18549
|
"description": "Date of birth of the DL holder in YYYY-MM-DD format. Used to cross-validate the license.",
|
|
18358
18550
|
"example": "1994-08-05",
|
|
@@ -18795,8 +18987,10 @@
|
|
|
18795
18987
|
"name": "client_ref_id",
|
|
18796
18988
|
"type": "string",
|
|
18797
18989
|
"required": false,
|
|
18798
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
18990
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
18799
18991
|
"example": "2026010100123456789",
|
|
18992
|
+
"format": "client-ref",
|
|
18993
|
+
"maxLength": 20,
|
|
18800
18994
|
"in": "body"
|
|
18801
18995
|
},
|
|
18802
18996
|
{
|
|
@@ -19516,8 +19710,10 @@
|
|
|
19516
19710
|
"name": "client_ref_id",
|
|
19517
19711
|
"type": "string",
|
|
19518
19712
|
"required": false,
|
|
19519
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
19713
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
19520
19714
|
"example": "2026010100123456789",
|
|
19715
|
+
"format": "client-ref",
|
|
19716
|
+
"maxLength": 20,
|
|
19521
19717
|
"in": "body"
|
|
19522
19718
|
},
|
|
19523
19719
|
{
|
|
@@ -20120,8 +20316,10 @@
|
|
|
20120
20316
|
"name": "client_ref_id",
|
|
20121
20317
|
"type": "string",
|
|
20122
20318
|
"required": false,
|
|
20123
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
20319
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
20124
20320
|
"example": "2026010100123456789",
|
|
20321
|
+
"format": "client-ref",
|
|
20322
|
+
"maxLength": 20,
|
|
20125
20323
|
"in": "body"
|
|
20126
20324
|
},
|
|
20127
20325
|
{
|
|
@@ -20355,8 +20553,10 @@
|
|
|
20355
20553
|
"name": "client_ref_id",
|
|
20356
20554
|
"type": "string",
|
|
20357
20555
|
"required": false,
|
|
20358
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
20556
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
20359
20557
|
"example": "2026010100123456789",
|
|
20558
|
+
"format": "client-ref",
|
|
20559
|
+
"maxLength": 20,
|
|
20360
20560
|
"in": "body"
|
|
20361
20561
|
},
|
|
20362
20562
|
{
|
|
@@ -20737,8 +20937,10 @@
|
|
|
20737
20937
|
"name": "client_ref_id",
|
|
20738
20938
|
"type": "string",
|
|
20739
20939
|
"required": false,
|
|
20740
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
20940
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
20741
20941
|
"example": "2026010100123456789",
|
|
20942
|
+
"format": "client-ref",
|
|
20943
|
+
"maxLength": 20,
|
|
20742
20944
|
"in": "body"
|
|
20743
20945
|
},
|
|
20744
20946
|
{
|
|
@@ -20752,6 +20954,7 @@
|
|
|
20752
20954
|
{
|
|
20753
20955
|
"name": "dob",
|
|
20754
20956
|
"type": "string",
|
|
20957
|
+
"format": "date",
|
|
20755
20958
|
"required": true,
|
|
20756
20959
|
"description": "Date of birth of the passport holder in YYYY-MM-DD format.",
|
|
20757
20960
|
"example": "1994-08-29",
|
|
@@ -20948,8 +21151,10 @@
|
|
|
20948
21151
|
"name": "client_ref_id",
|
|
20949
21152
|
"type": "string",
|
|
20950
21153
|
"required": false,
|
|
20951
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21154
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
20952
21155
|
"example": "2026010100123456789",
|
|
21156
|
+
"format": "client-ref",
|
|
21157
|
+
"maxLength": 20,
|
|
20953
21158
|
"in": "body"
|
|
20954
21159
|
},
|
|
20955
21160
|
{
|
|
@@ -21227,8 +21432,10 @@
|
|
|
21227
21432
|
"name": "client_ref_id",
|
|
21228
21433
|
"type": "string",
|
|
21229
21434
|
"required": false,
|
|
21230
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21435
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
21231
21436
|
"example": "2026010100123456789",
|
|
21437
|
+
"format": "client-ref",
|
|
21438
|
+
"maxLength": 20,
|
|
21232
21439
|
"in": "body"
|
|
21233
21440
|
},
|
|
21234
21441
|
{
|
|
@@ -21439,8 +21646,10 @@
|
|
|
21439
21646
|
"name": "client_ref_id",
|
|
21440
21647
|
"type": "string",
|
|
21441
21648
|
"required": false,
|
|
21442
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21649
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
21443
21650
|
"example": "2026010100123456789",
|
|
21651
|
+
"format": "client-ref",
|
|
21652
|
+
"maxLength": 20,
|
|
21444
21653
|
"in": "body"
|
|
21445
21654
|
},
|
|
21446
21655
|
{
|
|
@@ -21633,13 +21842,16 @@
|
|
|
21633
21842
|
"name": "client_ref_id",
|
|
21634
21843
|
"type": "string",
|
|
21635
21844
|
"required": false,
|
|
21636
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21845
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
21637
21846
|
"example": "2026010100123456789",
|
|
21847
|
+
"format": "client-ref",
|
|
21848
|
+
"maxLength": 20,
|
|
21638
21849
|
"in": "body"
|
|
21639
21850
|
},
|
|
21640
21851
|
{
|
|
21641
21852
|
"name": "pan_number",
|
|
21642
21853
|
"type": "string",
|
|
21854
|
+
"format": "pan",
|
|
21643
21855
|
"required": true,
|
|
21644
21856
|
"description": "PAN number of the individual or entity to check for ITR compliance (10-character alphanumeric, e.g. ABCDE1234F).",
|
|
21645
21857
|
"example": "ABCDE1234F",
|
|
@@ -21878,8 +22090,10 @@
|
|
|
21878
22090
|
"name": "client_ref_id",
|
|
21879
22091
|
"type": "string",
|
|
21880
22092
|
"required": false,
|
|
21881
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22093
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
21882
22094
|
"example": "2026010100123456789",
|
|
22095
|
+
"format": "client-ref",
|
|
22096
|
+
"maxLength": 20,
|
|
21883
22097
|
"in": "body"
|
|
21884
22098
|
},
|
|
21885
22099
|
{
|
|
@@ -22084,8 +22298,10 @@
|
|
|
22084
22298
|
"name": "client_ref_id",
|
|
22085
22299
|
"type": "string",
|
|
22086
22300
|
"required": false,
|
|
22087
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22301
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
22088
22302
|
"example": "2026010100123456789",
|
|
22303
|
+
"format": "client-ref",
|
|
22304
|
+
"maxLength": 20,
|
|
22089
22305
|
"in": "body"
|
|
22090
22306
|
},
|
|
22091
22307
|
{
|
|
@@ -22377,8 +22593,10 @@
|
|
|
22377
22593
|
"name": "client_ref_id",
|
|
22378
22594
|
"type": "string",
|
|
22379
22595
|
"required": false,
|
|
22380
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22596
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
22381
22597
|
"example": "2026010100123456789",
|
|
22598
|
+
"format": "client-ref",
|
|
22599
|
+
"maxLength": 20,
|
|
22382
22600
|
"in": "body"
|
|
22383
22601
|
},
|
|
22384
22602
|
{
|
|
@@ -22619,8 +22837,10 @@
|
|
|
22619
22837
|
"name": "client_ref_id",
|
|
22620
22838
|
"type": "string",
|
|
22621
22839
|
"required": false,
|
|
22622
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22840
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
22623
22841
|
"example": "2026010100123456789",
|
|
22842
|
+
"format": "client-ref",
|
|
22843
|
+
"maxLength": 20,
|
|
22624
22844
|
"in": "body"
|
|
22625
22845
|
},
|
|
22626
22846
|
{
|
|
@@ -22842,8 +23062,10 @@
|
|
|
22842
23062
|
"name": "client_ref_id",
|
|
22843
23063
|
"type": "string",
|
|
22844
23064
|
"required": false,
|
|
22845
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
23065
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
22846
23066
|
"example": "2026010100123456789",
|
|
23067
|
+
"format": "client-ref",
|
|
23068
|
+
"maxLength": 20,
|
|
22847
23069
|
"in": "body"
|
|
22848
23070
|
},
|
|
22849
23071
|
{
|
|
@@ -22859,6 +23081,7 @@
|
|
|
22859
23081
|
"name": "mobile",
|
|
22860
23082
|
"label": "Mobile Number",
|
|
22861
23083
|
"type": "string",
|
|
23084
|
+
"format": "mobile",
|
|
22862
23085
|
"required": true,
|
|
22863
23086
|
"description": "Customer's 10-digit primary mobile number to send the OTP to.",
|
|
22864
23087
|
"example": "9002336768",
|
|
@@ -23003,8 +23226,10 @@
|
|
|
23003
23226
|
"name": "client_ref_id",
|
|
23004
23227
|
"type": "string",
|
|
23005
23228
|
"required": false,
|
|
23006
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
23229
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
23007
23230
|
"example": "2026010100123456789",
|
|
23231
|
+
"format": "client-ref",
|
|
23232
|
+
"maxLength": 20,
|
|
23008
23233
|
"in": "body"
|
|
23009
23234
|
},
|
|
23010
23235
|
{
|
|
@@ -23020,6 +23245,7 @@
|
|
|
23020
23245
|
"name": "mobile",
|
|
23021
23246
|
"label": "Mobile Number",
|
|
23022
23247
|
"type": "string",
|
|
23248
|
+
"format": "mobile",
|
|
23023
23249
|
"required": true,
|
|
23024
23250
|
"description": "The same 10-digit mobile number the OTP was sent to.",
|
|
23025
23251
|
"example": "9002336768",
|
|
@@ -23185,8 +23411,10 @@
|
|
|
23185
23411
|
"name": "client_ref_id",
|
|
23186
23412
|
"type": "string",
|
|
23187
23413
|
"required": false,
|
|
23188
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
23414
|
+
"description": "Unique reference ID per API call, generated by your system (max 20 characters). The SDKs generate one for every non-GET call when you don't.",
|
|
23189
23415
|
"example": "2026010100123456789",
|
|
23416
|
+
"format": "client-ref",
|
|
23417
|
+
"maxLength": 20,
|
|
23190
23418
|
"in": "query"
|
|
23191
23419
|
},
|
|
23192
23420
|
{
|
|
@@ -23547,5 +23775,785 @@
|
|
|
23547
23775
|
}
|
|
23548
23776
|
]
|
|
23549
23777
|
}
|
|
23778
|
+
],
|
|
23779
|
+
"sdks": [
|
|
23780
|
+
{
|
|
23781
|
+
"lang": "javascript",
|
|
23782
|
+
"slug": "nodejs",
|
|
23783
|
+
"title": "Node.js SDK",
|
|
23784
|
+
"summary": "Backend-only Node.js client for every EPS API, with HMAC signing, input validation and typed errors built in.",
|
|
23785
|
+
"packageName": "@ekoindia/eps-sdk",
|
|
23786
|
+
"installCommand": "npm i @ekoindia/eps-sdk",
|
|
23787
|
+
"registry": "npm",
|
|
23788
|
+
"registryUrl": "https://www.npmjs.com/package/@ekoindia/eps-sdk",
|
|
23789
|
+
"minRuntime": "Node.js 18 or newer",
|
|
23790
|
+
"dependencies": "None — standard library only (`node:crypto`, global `fetch`).",
|
|
23791
|
+
"sourceUrl": "https://github.com/ekoindia/eps-platform/tree/main/packages/sdk-js",
|
|
23792
|
+
"docsUrl": "https://eps.eko.in/docs/sdk/nodejs",
|
|
23793
|
+
"config": [
|
|
23794
|
+
{
|
|
23795
|
+
"name": "developerKey",
|
|
23796
|
+
"type": "string",
|
|
23797
|
+
"required": true,
|
|
23798
|
+
"description": "Your EPS developer key, sent as the `developer_key` header."
|
|
23799
|
+
},
|
|
23800
|
+
{
|
|
23801
|
+
"name": "accessKey",
|
|
23802
|
+
"type": "string",
|
|
23803
|
+
"required": true,
|
|
23804
|
+
"description": "Server-side secret used to sign every request. Never ships to a browser."
|
|
23805
|
+
},
|
|
23806
|
+
{
|
|
23807
|
+
"name": "environment",
|
|
23808
|
+
"type": "\"sandbox\" | \"production\"",
|
|
23809
|
+
"required": true,
|
|
23810
|
+
"description": "Selects the base URL from the embedded surface."
|
|
23811
|
+
},
|
|
23812
|
+
{
|
|
23813
|
+
"name": "initiatorId",
|
|
23814
|
+
"type": "string",
|
|
23815
|
+
"required": false,
|
|
23816
|
+
"description": "Default `initiator_id` (registered mobile of the API user) injected into every call."
|
|
23817
|
+
},
|
|
23818
|
+
{
|
|
23819
|
+
"name": "userCode",
|
|
23820
|
+
"type": "string",
|
|
23821
|
+
"required": false,
|
|
23822
|
+
"description": "Default `user_code` (retailer/agent code) injected into every call."
|
|
23823
|
+
},
|
|
23824
|
+
{
|
|
23825
|
+
"name": "timeoutMs",
|
|
23826
|
+
"type": "number",
|
|
23827
|
+
"required": false,
|
|
23828
|
+
"units": "milliseconds, default 30_000",
|
|
23829
|
+
"description": "Aborts a request that takes longer. Named for its unit — Python and PHP use seconds."
|
|
23830
|
+
},
|
|
23831
|
+
{
|
|
23832
|
+
"name": "fetch",
|
|
23833
|
+
"type": "typeof fetch",
|
|
23834
|
+
"required": false,
|
|
23835
|
+
"description": "Inject a custom fetch implementation (proxies, tests)."
|
|
23836
|
+
},
|
|
23837
|
+
{
|
|
23838
|
+
"name": "retries",
|
|
23839
|
+
"type": "number",
|
|
23840
|
+
"required": false,
|
|
23841
|
+
"units": "default 2",
|
|
23842
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
23843
|
+
},
|
|
23844
|
+
{
|
|
23845
|
+
"name": "retryBaseDelayMs",
|
|
23846
|
+
"type": "number",
|
|
23847
|
+
"required": false,
|
|
23848
|
+
"units": "milliseconds, default 200",
|
|
23849
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
23850
|
+
},
|
|
23851
|
+
{
|
|
23852
|
+
"name": "autoStatusCheck",
|
|
23853
|
+
"type": "boolean",
|
|
23854
|
+
"required": false,
|
|
23855
|
+
"units": "default true",
|
|
23856
|
+
"description": "After an indeterminate failure on a money-moving endpoint, look the transaction up by its `client_ref_id` and attach the result to the indeterminate error."
|
|
23857
|
+
}
|
|
23858
|
+
],
|
|
23859
|
+
"members": [
|
|
23860
|
+
{
|
|
23861
|
+
"kind": "class",
|
|
23862
|
+
"name": "EpsClient",
|
|
23863
|
+
"signature": "new EpsClient(options: EpsClientOptions)",
|
|
23864
|
+
"description": "The client. Throws immediately if constructed where `window` exists — `accessKey` must never reach a browser."
|
|
23865
|
+
},
|
|
23866
|
+
{
|
|
23867
|
+
"kind": "method",
|
|
23868
|
+
"name": "call",
|
|
23869
|
+
"signature": "client.call<T = unknown>(slug: string, params?: Record<string, unknown>): Promise<T>",
|
|
23870
|
+
"description": "Validates, signs and sends one endpoint call; resolves with the decoded envelope."
|
|
23871
|
+
},
|
|
23872
|
+
{
|
|
23873
|
+
"kind": "function",
|
|
23874
|
+
"name": "signSecretKey",
|
|
23875
|
+
"signature": "signSecretKey(accessKey: string, timestamp: string): string",
|
|
23876
|
+
"description": "The raw signing primitive, exported for debugging. `call()` applies it for you."
|
|
23877
|
+
},
|
|
23878
|
+
{
|
|
23879
|
+
"kind": "constant",
|
|
23880
|
+
"name": "MULTIPART_JSON_FIELD",
|
|
23881
|
+
"signature": "MULTIPART_JSON_FIELD = \"form-data\"",
|
|
23882
|
+
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
23883
|
+
},
|
|
23884
|
+
{
|
|
23885
|
+
"kind": "type",
|
|
23886
|
+
"name": "EpsClientOptions",
|
|
23887
|
+
"signature": "interface EpsClientOptions",
|
|
23888
|
+
"description": "The constructor options above."
|
|
23889
|
+
},
|
|
23890
|
+
{
|
|
23891
|
+
"kind": "type",
|
|
23892
|
+
"name": "SdkEndpoint / SdkParam",
|
|
23893
|
+
"signature": "interface SdkEndpoint, interface SdkParam",
|
|
23894
|
+
"description": "Shape of one endpoint in the embedded surface (slug, method, path, params)."
|
|
23895
|
+
},
|
|
23896
|
+
{
|
|
23897
|
+
"kind": "function",
|
|
23898
|
+
"name": "generateClientRefId",
|
|
23899
|
+
"signature": "generateClientRefId(nowMs: number): string",
|
|
23900
|
+
"description": "The 15-char `client_ref_id` generator `call()` uses for a non-GET call that did not supply one — exported so you can mint refs the same way."
|
|
23901
|
+
}
|
|
23902
|
+
],
|
|
23903
|
+
"errorTypes": [
|
|
23904
|
+
{
|
|
23905
|
+
"name": "EpsIndeterminateError",
|
|
23906
|
+
"when": "A money-moving (`financial`) non-GET call ended with no confirmed outcome — timeout, transport failure, HTTP 429/5xx. The SDK did not re-send it; it looked the transaction up by its `client_ref_id` and attached the result. Reconcile before retrying.",
|
|
23907
|
+
"fields": "`slug`, `clientRefId`, `status` (or null), `statusCheck` (inquiry envelope or null), `statusCheckError`, `cause`"
|
|
23908
|
+
},
|
|
23909
|
+
{
|
|
23910
|
+
"name": "EpsHttpError",
|
|
23911
|
+
"when": "Any non-2xx response.",
|
|
23912
|
+
"fields": "`status`, `url`, `body` (decoded envelope or null), `raw`"
|
|
23913
|
+
},
|
|
23914
|
+
{
|
|
23915
|
+
"name": "EpsError",
|
|
23916
|
+
"when": "Unknown slug, missing required param, wrong param type, bad option, or a 2xx body that is not JSON. `EpsHttpError` extends it."
|
|
23917
|
+
},
|
|
23918
|
+
{
|
|
23919
|
+
"name": "TimeoutError (DOMException)",
|
|
23920
|
+
"when": "The request exceeded `timeoutMs`. Surfaced raw, as Node reports it."
|
|
23921
|
+
}
|
|
23922
|
+
],
|
|
23923
|
+
"fileValues": [
|
|
23924
|
+
"A local file path (read from disk; the filename is the basename)",
|
|
23925
|
+
"A `Blob` or `File` (a `File` keeps its own name)"
|
|
23926
|
+
],
|
|
23927
|
+
"notes": [
|
|
23928
|
+
"ESM only (`\"type\": \"module\"`). Use `import`, or `await import()` from CommonJS.",
|
|
23929
|
+
"A per-call cancellation signal is not supported yet — `timeoutMs` is the only abort source."
|
|
23930
|
+
],
|
|
23931
|
+
"example": "import { EpsClient } from \"@ekoindia/eps-sdk\";\n\nconst client = new EpsClient({\n developerKey: process.env.EPS_DEVELOPER_KEY,\n accessKey: process.env.EPS_ACCESS_KEY,\n initiatorId: \"9962981729\",\n environment: \"sandbox\",\n});\n\nconst result = await client.call(\"pan-lite\", {\n \"pan_number\": \"ABCDE1234F\",\n \"name\": \"Rajesh Kumar\",\n \"dob\": \"1994-08-29\"\n});\nconsole.log(result);"
|
|
23932
|
+
},
|
|
23933
|
+
{
|
|
23934
|
+
"lang": "python",
|
|
23935
|
+
"slug": "python",
|
|
23936
|
+
"title": "Python SDK",
|
|
23937
|
+
"summary": "Backend-only Python client for every EPS API, dependency-free and typed, with HMAC signing built in.",
|
|
23938
|
+
"packageName": "eps-sdk",
|
|
23939
|
+
"installCommand": "pip install eps-sdk",
|
|
23940
|
+
"registry": "PyPI",
|
|
23941
|
+
"registryUrl": "https://pypi.org/project/eps-sdk/",
|
|
23942
|
+
"minRuntime": "Python 3.9 or newer",
|
|
23943
|
+
"dependencies": "None — standard library only (`urllib`, `hmac`, `hashlib`, `mimetypes`).",
|
|
23944
|
+
"sourceUrl": "https://github.com/ekoindia/eps-platform/tree/main/packages/sdk-python",
|
|
23945
|
+
"docsUrl": "https://eps.eko.in/docs/sdk/python",
|
|
23946
|
+
"config": [
|
|
23947
|
+
{
|
|
23948
|
+
"name": "developer_key",
|
|
23949
|
+
"type": "str",
|
|
23950
|
+
"required": true,
|
|
23951
|
+
"description": "Your EPS developer key, sent as the `developer_key` header."
|
|
23952
|
+
},
|
|
23953
|
+
{
|
|
23954
|
+
"name": "access_key",
|
|
23955
|
+
"type": "str",
|
|
23956
|
+
"required": true,
|
|
23957
|
+
"description": "Server-side secret used to sign every request. Never ships to a browser."
|
|
23958
|
+
},
|
|
23959
|
+
{
|
|
23960
|
+
"name": "environment",
|
|
23961
|
+
"type": "\"sandbox\" | \"production\"",
|
|
23962
|
+
"required": true,
|
|
23963
|
+
"description": "Selects the base URL from the embedded surface."
|
|
23964
|
+
},
|
|
23965
|
+
{
|
|
23966
|
+
"name": "initiator_id",
|
|
23967
|
+
"type": "str",
|
|
23968
|
+
"required": false,
|
|
23969
|
+
"description": "Default `initiator_id` (registered mobile of the API user) injected into every call."
|
|
23970
|
+
},
|
|
23971
|
+
{
|
|
23972
|
+
"name": "user_code",
|
|
23973
|
+
"type": "str",
|
|
23974
|
+
"required": false,
|
|
23975
|
+
"description": "Default `user_code` (retailer/agent code) injected into every call."
|
|
23976
|
+
},
|
|
23977
|
+
{
|
|
23978
|
+
"name": "timeout",
|
|
23979
|
+
"type": "float",
|
|
23980
|
+
"required": false,
|
|
23981
|
+
"units": "seconds, default 30.0",
|
|
23982
|
+
"description": "Whole-request budget passed through to `urlopen`."
|
|
23983
|
+
},
|
|
23984
|
+
{
|
|
23985
|
+
"name": "retries",
|
|
23986
|
+
"type": "int",
|
|
23987
|
+
"required": false,
|
|
23988
|
+
"units": "default 2",
|
|
23989
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
23990
|
+
},
|
|
23991
|
+
{
|
|
23992
|
+
"name": "retry_base_delay",
|
|
23993
|
+
"type": "float",
|
|
23994
|
+
"required": false,
|
|
23995
|
+
"units": "seconds, default 0.2",
|
|
23996
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
23997
|
+
},
|
|
23998
|
+
{
|
|
23999
|
+
"name": "auto_status_check",
|
|
24000
|
+
"type": "bool",
|
|
24001
|
+
"required": false,
|
|
24002
|
+
"units": "default true",
|
|
24003
|
+
"description": "After an indeterminate failure on a money-moving endpoint, look the transaction up by its `client_ref_id` and attach the result to the indeterminate error."
|
|
24004
|
+
}
|
|
24005
|
+
],
|
|
24006
|
+
"members": [
|
|
24007
|
+
{
|
|
24008
|
+
"kind": "class",
|
|
24009
|
+
"name": "EpsClient",
|
|
24010
|
+
"signature": "EpsClient(developer_key, access_key, environment, initiator_id=None, user_code=None, timeout=30.0)",
|
|
24011
|
+
"description": "The client — a dataclass, so keyword arguments read well."
|
|
24012
|
+
},
|
|
24013
|
+
{
|
|
24014
|
+
"kind": "method",
|
|
24015
|
+
"name": "call",
|
|
24016
|
+
"signature": "client.call(slug: str, params: Mapping[str, Any] | None = None) -> Any",
|
|
24017
|
+
"description": "Validates, signs and sends one endpoint call; returns the decoded envelope."
|
|
24018
|
+
},
|
|
24019
|
+
{
|
|
24020
|
+
"kind": "method",
|
|
24021
|
+
"name": "resolve_target",
|
|
24022
|
+
"signature": "client.resolve_target(slug, params=None) -> Target",
|
|
24023
|
+
"description": "The signed method/url/body/headers for a call, without sending it. Useful for debugging."
|
|
24024
|
+
},
|
|
24025
|
+
{
|
|
24026
|
+
"kind": "method",
|
|
24027
|
+
"name": "build_headers",
|
|
24028
|
+
"signature": "client.build_headers(multipart: bool = False) -> dict[str, str]",
|
|
24029
|
+
"description": "The four auth headers for a single request."
|
|
24030
|
+
},
|
|
24031
|
+
{
|
|
24032
|
+
"kind": "function",
|
|
24033
|
+
"name": "sign_secret_key",
|
|
24034
|
+
"signature": "sign_secret_key(access_key: str, timestamp: str) -> str",
|
|
24035
|
+
"description": "The raw signing primitive, exported for debugging."
|
|
24036
|
+
},
|
|
24037
|
+
{
|
|
24038
|
+
"kind": "constant",
|
|
24039
|
+
"name": "MULTIPART_JSON_FIELD",
|
|
24040
|
+
"signature": "MULTIPART_JSON_FIELD = \"form-data\"",
|
|
24041
|
+
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
24042
|
+
},
|
|
24043
|
+
{
|
|
24044
|
+
"kind": "type",
|
|
24045
|
+
"name": "Target",
|
|
24046
|
+
"signature": "@dataclass Target(method, url, body, headers, multipart)",
|
|
24047
|
+
"description": "What `resolve_target` returns."
|
|
24048
|
+
},
|
|
24049
|
+
{
|
|
24050
|
+
"kind": "function",
|
|
24051
|
+
"name": "generate_client_ref_id",
|
|
24052
|
+
"signature": "generate_client_ref_id(now_ms: int) -> str",
|
|
24053
|
+
"description": "The 15-char `client_ref_id` generator `call()` uses for a non-GET call that did not supply one — exported so you can mint refs the same way."
|
|
24054
|
+
}
|
|
24055
|
+
],
|
|
24056
|
+
"errorTypes": [
|
|
24057
|
+
{
|
|
24058
|
+
"name": "EpsIndeterminateError",
|
|
24059
|
+
"when": "A money-moving (`financial`) non-GET call ended with no confirmed outcome — timeout, transport failure, HTTP 429/5xx. The SDK did not re-send it; it looked the transaction up by its `client_ref_id` and attached the result. Reconcile before retrying.",
|
|
24060
|
+
"fields": "`slug`, `client_ref_id`, `status` (or None), `status_check`, `status_check_error`, `__cause__`"
|
|
24061
|
+
},
|
|
24062
|
+
{
|
|
24063
|
+
"name": "EpsHttpError",
|
|
24064
|
+
"when": "Any non-2xx response.",
|
|
24065
|
+
"fields": "`.status`, `.url`, `.body` (decoded envelope or None), `.raw` (bytes)"
|
|
24066
|
+
},
|
|
24067
|
+
{
|
|
24068
|
+
"name": "EpsError",
|
|
24069
|
+
"when": "Unknown slug, missing required param, wrong param type, bad config, or a 2xx body that is not JSON. `EpsHttpError` subclasses it."
|
|
24070
|
+
},
|
|
24071
|
+
{
|
|
24072
|
+
"name": "urllib.error.URLError",
|
|
24073
|
+
"when": "Transport failure or timeout. Surfaced raw."
|
|
24074
|
+
}
|
|
24075
|
+
],
|
|
24076
|
+
"fileValues": [
|
|
24077
|
+
"A path `str` or `os.PathLike` (the MIME type is guessed, falling back to `application/octet-stream`)",
|
|
24078
|
+
"An in-memory `(filename, bytes)` tuple"
|
|
24079
|
+
],
|
|
24080
|
+
"notes": [
|
|
24081
|
+
"Paths are checked for existence during validation, so a typo fails before the request is signed."
|
|
24082
|
+
],
|
|
24083
|
+
"example": "import os\n\nfrom eps_sdk import EpsClient\n\nclient = EpsClient(\n developer_key=os.environ[\"EPS_DEVELOPER_KEY\"],\n access_key=os.environ[\"EPS_ACCESS_KEY\"],\n initiator_id=\"9962981729\",\n environment=\"sandbox\",\n)\n\nresult = client.call(\"pan-lite\", {\n \"pan_number\": \"ABCDE1234F\",\n \"name\": \"Rajesh Kumar\",\n \"dob\": \"1994-08-29\",\n})\nprint(result)"
|
|
24084
|
+
},
|
|
24085
|
+
{
|
|
24086
|
+
"lang": "php",
|
|
24087
|
+
"slug": "php",
|
|
24088
|
+
"title": "PHP SDK",
|
|
24089
|
+
"summary": "Backend-only PHP client for every EPS API, with HMAC signing, input validation and typed errors built in.",
|
|
24090
|
+
"packageName": "ekoindia/eps-sdk",
|
|
24091
|
+
"installCommand": "composer require ekoindia/eps-sdk",
|
|
24092
|
+
"registry": "Packagist",
|
|
24093
|
+
"registryUrl": "https://packagist.org/packages/ekoindia/eps-sdk",
|
|
24094
|
+
"minRuntime": "PHP 8.1 or newer",
|
|
24095
|
+
"dependencies": "None beyond the `curl` and `json` extensions.",
|
|
24096
|
+
"sourceUrl": "https://github.com/ekoindia/eps-platform/tree/main/packages/sdk-php",
|
|
24097
|
+
"docsUrl": "https://eps.eko.in/docs/sdk/php",
|
|
24098
|
+
"installNotes": [
|
|
24099
|
+
"Published from a read-only mirror (`ekoindia/eps-sdk-php`), subtree-split from the monorepo."
|
|
24100
|
+
],
|
|
24101
|
+
"config": [
|
|
24102
|
+
{
|
|
24103
|
+
"name": "$developerKey",
|
|
24104
|
+
"type": "string",
|
|
24105
|
+
"required": true,
|
|
24106
|
+
"description": "Your EPS developer key, sent as the `developer_key` header."
|
|
24107
|
+
},
|
|
24108
|
+
{
|
|
24109
|
+
"name": "$accessKey",
|
|
24110
|
+
"type": "string",
|
|
24111
|
+
"required": true,
|
|
24112
|
+
"description": "Server-side secret used to sign every request. Never ships to a browser."
|
|
24113
|
+
},
|
|
24114
|
+
{
|
|
24115
|
+
"name": "$environment",
|
|
24116
|
+
"type": "\"sandbox\" | \"production\"",
|
|
24117
|
+
"required": true,
|
|
24118
|
+
"description": "Selects the base URL from the embedded surface."
|
|
24119
|
+
},
|
|
24120
|
+
{
|
|
24121
|
+
"name": "$initiatorId",
|
|
24122
|
+
"type": "string",
|
|
24123
|
+
"required": false,
|
|
24124
|
+
"description": "Default `initiator_id` (registered mobile of the API user) injected into every call."
|
|
24125
|
+
},
|
|
24126
|
+
{
|
|
24127
|
+
"name": "$userCode",
|
|
24128
|
+
"type": "string",
|
|
24129
|
+
"required": false,
|
|
24130
|
+
"description": "Default `user_code` (retailer/agent code) injected into every call."
|
|
24131
|
+
},
|
|
24132
|
+
{
|
|
24133
|
+
"name": "$timeout",
|
|
24134
|
+
"type": "float",
|
|
24135
|
+
"required": false,
|
|
24136
|
+
"units": "seconds, default 30.0",
|
|
24137
|
+
"description": "Whole-request budget, applied as `CURLOPT_TIMEOUT_MS` so sub-second values are not truncated."
|
|
24138
|
+
},
|
|
24139
|
+
{
|
|
24140
|
+
"name": "retries",
|
|
24141
|
+
"type": "int",
|
|
24142
|
+
"required": false,
|
|
24143
|
+
"units": "default 2",
|
|
24144
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24145
|
+
},
|
|
24146
|
+
{
|
|
24147
|
+
"name": "retryBaseDelay",
|
|
24148
|
+
"type": "float",
|
|
24149
|
+
"required": false,
|
|
24150
|
+
"units": "seconds, default 0.2",
|
|
24151
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24152
|
+
},
|
|
24153
|
+
{
|
|
24154
|
+
"name": "autoStatusCheck",
|
|
24155
|
+
"type": "bool",
|
|
24156
|
+
"required": false,
|
|
24157
|
+
"units": "default true",
|
|
24158
|
+
"description": "After an indeterminate failure on a money-moving endpoint, look the transaction up by its `client_ref_id` and attach the result to the indeterminate error."
|
|
24159
|
+
}
|
|
24160
|
+
],
|
|
24161
|
+
"members": [
|
|
24162
|
+
{
|
|
24163
|
+
"kind": "class",
|
|
24164
|
+
"name": "Eko\\Eps\\EpsClient",
|
|
24165
|
+
"signature": "new EpsClient(string $developerKey, string $accessKey, string $environment, ?string $initiatorId = null, ?string $userCode = null, float $timeout = 30.0)",
|
|
24166
|
+
"description": "The client. Use named arguments."
|
|
24167
|
+
},
|
|
24168
|
+
{
|
|
24169
|
+
"kind": "method",
|
|
24170
|
+
"name": "call",
|
|
24171
|
+
"signature": "$client->call(string $slug, array $params = []): array",
|
|
24172
|
+
"description": "Validates, signs and sends one endpoint call; returns the decoded envelope."
|
|
24173
|
+
},
|
|
24174
|
+
{
|
|
24175
|
+
"kind": "method",
|
|
24176
|
+
"name": "resolveTarget",
|
|
24177
|
+
"signature": "$client->resolveTarget(string $slug, array $params = []): array",
|
|
24178
|
+
"description": "The signed url/body/method for a call, without sending it. Exposed for testing."
|
|
24179
|
+
},
|
|
24180
|
+
{
|
|
24181
|
+
"kind": "method",
|
|
24182
|
+
"name": "curlOptions",
|
|
24183
|
+
"signature": "$client->curlOptions(array $target): array",
|
|
24184
|
+
"description": "The cURL option map `call()` uses, including the timeout. Exposed for testing."
|
|
24185
|
+
},
|
|
24186
|
+
{
|
|
24187
|
+
"kind": "method",
|
|
24188
|
+
"name": "decodeResponse",
|
|
24189
|
+
"signature": "EpsClient::decodeResponse(int $status, string $url, string $raw): array",
|
|
24190
|
+
"description": "Static. Applies the shared response contract to one raw response — the seam the conformance tests drive."
|
|
24191
|
+
},
|
|
24192
|
+
{
|
|
24193
|
+
"kind": "method",
|
|
24194
|
+
"name": "signSecretKey",
|
|
24195
|
+
"signature": "EpsClient::signSecretKey(string $accessKey, string $timestamp): string",
|
|
24196
|
+
"description": "Static. The raw signing primitive, exposed for debugging."
|
|
24197
|
+
},
|
|
24198
|
+
{
|
|
24199
|
+
"kind": "constant",
|
|
24200
|
+
"name": "EpsClient::MULTIPART_JSON_FIELD",
|
|
24201
|
+
"signature": "const MULTIPART_JSON_FIELD = 'form-data'",
|
|
24202
|
+
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
24203
|
+
},
|
|
24204
|
+
{
|
|
24205
|
+
"kind": "method",
|
|
24206
|
+
"name": "EpsClient::generateClientRefId",
|
|
24207
|
+
"signature": "EpsClient::generateClientRefId(int $nowMs): string",
|
|
24208
|
+
"description": "The 15-char `client_ref_id` generator `call()` uses for a non-GET call that did not supply one — exported so you can mint refs the same way."
|
|
24209
|
+
}
|
|
24210
|
+
],
|
|
24211
|
+
"errorTypes": [
|
|
24212
|
+
{
|
|
24213
|
+
"name": "Eko\\Eps\\EpsIndeterminateException",
|
|
24214
|
+
"when": "A money-moving (`financial`) non-GET call ended with no confirmed outcome — timeout, transport failure, HTTP 429/5xx. The SDK did not re-send it; it looked the transaction up by its `client_ref_id` and attached the result. Reconcile before retrying.",
|
|
24215
|
+
"fields": "`slug`, `clientRefId`, `status` (or null), `statusCheck`, `statusCheckError`, `getPrevious()`"
|
|
24216
|
+
},
|
|
24217
|
+
{
|
|
24218
|
+
"name": "Eko\\Eps\\EpsTransportException",
|
|
24219
|
+
"when": "The request produced no response at all (DNS, connect, TLS, timeout). Retried on GET; wraps the native error."
|
|
24220
|
+
},
|
|
24221
|
+
{
|
|
24222
|
+
"name": "Eko\\Eps\\EpsHttpException",
|
|
24223
|
+
"when": "Any non-2xx response.",
|
|
24224
|
+
"fields": "`->status`, `->url`, `->body` (decoded envelope or null), `->raw`"
|
|
24225
|
+
},
|
|
24226
|
+
{
|
|
24227
|
+
"name": "Eko\\Eps\\EpsException",
|
|
24228
|
+
"when": "Transport failure, a malformed surface asset, or a 2xx body that is not JSON. Extends `\\RuntimeException`."
|
|
24229
|
+
},
|
|
24230
|
+
{
|
|
24231
|
+
"name": "\\InvalidArgumentException",
|
|
24232
|
+
"when": "Unknown environment or slug, missing required param, wrong param type. SPL already has the right class, and it is a `\\LogicException`, so it cannot share a base with the runtime failures."
|
|
24233
|
+
}
|
|
24234
|
+
],
|
|
24235
|
+
"fileValues": [
|
|
24236
|
+
"A local file path (wrapped in a `CURLFile` for you)",
|
|
24237
|
+
"A `\\CURLFile` you built yourself"
|
|
24238
|
+
],
|
|
24239
|
+
"notes": [
|
|
24240
|
+
"Presence is checked with `isset()`, so a param explicitly set to `null` counts as missing — matching every other SDK."
|
|
24241
|
+
],
|
|
24242
|
+
"example": "<?php\nuse Eko\\Eps\\EpsClient;\n\n$client = new EpsClient(\n developerKey: getenv('EPS_DEVELOPER_KEY'),\n accessKey: getenv('EPS_ACCESS_KEY'),\n initiatorId: '9962981729',\n environment: 'sandbox'\n);\n\n$result = $client->call('pan-lite', [\n 'pan_number' => 'ABCDE1234F',\n 'name' => 'Rajesh Kumar',\n 'dob' => '1994-08-29'\n]);\nprint_r($result);"
|
|
24243
|
+
},
|
|
24244
|
+
{
|
|
24245
|
+
"lang": "go",
|
|
24246
|
+
"slug": "go",
|
|
24247
|
+
"title": "Go SDK",
|
|
24248
|
+
"summary": "Backend-only Go client for every EPS API — standard library only, context-aware, with HMAC signing built in.",
|
|
24249
|
+
"packageName": "github.com/ekoindia/eps-sdk-go",
|
|
24250
|
+
"installCommand": "go get github.com/ekoindia/eps-sdk-go",
|
|
24251
|
+
"registry": "Go modules",
|
|
24252
|
+
"registryUrl": "https://pkg.go.dev/github.com/ekoindia/eps-sdk-go",
|
|
24253
|
+
"minRuntime": "Go 1.22 or newer",
|
|
24254
|
+
"dependencies": "None — `go.mod` has no `require` block and there is no `go.sum`.",
|
|
24255
|
+
"sourceUrl": "https://github.com/ekoindia/eps-platform/tree/main/packages/sdk-go",
|
|
24256
|
+
"docsUrl": "https://eps.eko.in/docs/sdk/go",
|
|
24257
|
+
"installNotes": [
|
|
24258
|
+
"Published from a read-only mirror (`ekoindia/eps-sdk-go`) as a git tag; there is no separate registry."
|
|
24259
|
+
],
|
|
24260
|
+
"config": [
|
|
24261
|
+
{
|
|
24262
|
+
"name": "DeveloperKey",
|
|
24263
|
+
"type": "string",
|
|
24264
|
+
"required": true,
|
|
24265
|
+
"description": "Your EPS developer key, sent as the `developer_key` header."
|
|
24266
|
+
},
|
|
24267
|
+
{
|
|
24268
|
+
"name": "AccessKey",
|
|
24269
|
+
"type": "string",
|
|
24270
|
+
"required": true,
|
|
24271
|
+
"description": "Server-side secret used to sign every request. Never ships to a browser."
|
|
24272
|
+
},
|
|
24273
|
+
{
|
|
24274
|
+
"name": "Environment",
|
|
24275
|
+
"type": "\"sandbox\" | \"production\"",
|
|
24276
|
+
"required": true,
|
|
24277
|
+
"description": "Selects the base URL from the embedded surface."
|
|
24278
|
+
},
|
|
24279
|
+
{
|
|
24280
|
+
"name": "InitiatorID",
|
|
24281
|
+
"type": "string",
|
|
24282
|
+
"required": false,
|
|
24283
|
+
"description": "Default `initiator_id` (registered mobile of the API user) injected into every call."
|
|
24284
|
+
},
|
|
24285
|
+
{
|
|
24286
|
+
"name": "UserCode",
|
|
24287
|
+
"type": "string",
|
|
24288
|
+
"required": false,
|
|
24289
|
+
"description": "Default `user_code` (retailer/agent code) injected into every call."
|
|
24290
|
+
},
|
|
24291
|
+
{
|
|
24292
|
+
"name": "HTTPClient",
|
|
24293
|
+
"type": "*http.Client",
|
|
24294
|
+
"required": false,
|
|
24295
|
+
"units": "default: 30s timeout",
|
|
24296
|
+
"description": "Control timeouts, proxies or retries by supplying your own client."
|
|
24297
|
+
},
|
|
24298
|
+
{
|
|
24299
|
+
"name": "Retries",
|
|
24300
|
+
"type": "*int (nil → 2)",
|
|
24301
|
+
"required": false,
|
|
24302
|
+
"units": "default 2",
|
|
24303
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24304
|
+
},
|
|
24305
|
+
{
|
|
24306
|
+
"name": "RetryBaseDelay",
|
|
24307
|
+
"type": "time.Duration",
|
|
24308
|
+
"required": false,
|
|
24309
|
+
"units": "default 200ms",
|
|
24310
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24311
|
+
},
|
|
24312
|
+
{
|
|
24313
|
+
"name": "AutoStatusCheck",
|
|
24314
|
+
"type": "*bool (nil → true)",
|
|
24315
|
+
"required": false,
|
|
24316
|
+
"units": "default true",
|
|
24317
|
+
"description": "After an indeterminate failure on a money-moving endpoint, look the transaction up by its `client_ref_id` and attach the result to the indeterminate error."
|
|
24318
|
+
}
|
|
24319
|
+
],
|
|
24320
|
+
"members": [
|
|
24321
|
+
{
|
|
24322
|
+
"kind": "function",
|
|
24323
|
+
"name": "eps.New",
|
|
24324
|
+
"signature": "eps.New(cfg eps.Config) (*eps.Client, error)",
|
|
24325
|
+
"description": "Builds a client. Safe for concurrent use once constructed."
|
|
24326
|
+
},
|
|
24327
|
+
{
|
|
24328
|
+
"kind": "method",
|
|
24329
|
+
"name": "Call",
|
|
24330
|
+
"signature": "client.Call(ctx context.Context, slug string, params map[string]any) (map[string]any, error)",
|
|
24331
|
+
"description": "Validates, signs and sends one endpoint call. The only SDK with per-call cancellation."
|
|
24332
|
+
},
|
|
24333
|
+
{
|
|
24334
|
+
"kind": "method",
|
|
24335
|
+
"name": "ResolveTarget",
|
|
24336
|
+
"signature": "client.ResolveTarget(slug string, params map[string]any) (*eps.Target, error)",
|
|
24337
|
+
"description": "The signed request for a call, without sending it."
|
|
24338
|
+
},
|
|
24339
|
+
{
|
|
24340
|
+
"kind": "method",
|
|
24341
|
+
"name": "BuildHeaders",
|
|
24342
|
+
"signature": "client.BuildHeaders(multipartBody bool) map[string]string",
|
|
24343
|
+
"description": "The four auth headers for a single request."
|
|
24344
|
+
},
|
|
24345
|
+
{
|
|
24346
|
+
"kind": "function",
|
|
24347
|
+
"name": "eps.Sign",
|
|
24348
|
+
"signature": "eps.Sign(accessKey, timestamp string) string",
|
|
24349
|
+
"description": "The raw signing primitive, exported for debugging."
|
|
24350
|
+
},
|
|
24351
|
+
{
|
|
24352
|
+
"kind": "type",
|
|
24353
|
+
"name": "eps.File",
|
|
24354
|
+
"signature": "eps.File{Name string; Content []byte}",
|
|
24355
|
+
"description": "An in-memory upload."
|
|
24356
|
+
},
|
|
24357
|
+
{
|
|
24358
|
+
"kind": "constant",
|
|
24359
|
+
"name": "eps.MultipartJSONField",
|
|
24360
|
+
"signature": "MultipartJSONField = \"form-data\"",
|
|
24361
|
+
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
24362
|
+
},
|
|
24363
|
+
{
|
|
24364
|
+
"kind": "function",
|
|
24365
|
+
"name": "GenerateClientRefID",
|
|
24366
|
+
"signature": "eps.GenerateClientRefID(nowMs int64) string",
|
|
24367
|
+
"description": "The 15-char `client_ref_id` generator `call()` uses for a non-GET call that did not supply one — exported so you can mint refs the same way."
|
|
24368
|
+
}
|
|
24369
|
+
],
|
|
24370
|
+
"errorTypes": [
|
|
24371
|
+
{
|
|
24372
|
+
"name": "*eps.IndeterminateError",
|
|
24373
|
+
"when": "A money-moving (`financial`) non-GET call ended with no confirmed outcome — timeout, transport failure, HTTP 429/5xx. The SDK did not re-send it; it looked the transaction up by its `client_ref_id` and attached the result. Reconcile before retrying.",
|
|
24374
|
+
"fields": "`Slug`, `ClientRefID`, `Status` (0 for transport), `StatusCheck`, `StatusCheckErr`, `Unwrap()`"
|
|
24375
|
+
},
|
|
24376
|
+
{
|
|
24377
|
+
"name": "*eps.TransportError",
|
|
24378
|
+
"when": "The request produced no response at all (DNS, connect, TLS, timeout). Retried on GET; wraps the native error."
|
|
24379
|
+
},
|
|
24380
|
+
{
|
|
24381
|
+
"name": "*eps.HTTPError",
|
|
24382
|
+
"when": "Any non-2xx response. Match it with `errors.As`.",
|
|
24383
|
+
"fields": "`StatusCode`, `URL`, `Body` (decoded envelope or nil), `Raw`"
|
|
24384
|
+
},
|
|
24385
|
+
{
|
|
24386
|
+
"name": "error",
|
|
24387
|
+
"when": "Unknown slug, missing required param, wrong param type, a 2xx body that is not JSON, or a transport failure. Messages are lowercase and `eps:`-prefixed, per Go convention."
|
|
24388
|
+
}
|
|
24389
|
+
],
|
|
24390
|
+
"fileValues": [
|
|
24391
|
+
"A local file path `string`",
|
|
24392
|
+
"An `eps.File{Name, Content}` (or `*eps.File`) for an in-memory upload"
|
|
24393
|
+
],
|
|
24394
|
+
"notes": [
|
|
24395
|
+
"Map keys are sorted before encoding, so query strings and multipart bodies are byte-deterministic.",
|
|
24396
|
+
"The surface is embedded with `go:embed`, so the package needs no network call to resolve a slug."
|
|
24397
|
+
],
|
|
24398
|
+
"example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\t\"os\"\n\n\teps \"github.com/ekoindia/eps-sdk-go\"\n)\n\nfunc main() {\n\tclient, err := eps.New(eps.Config{\n\t\tDeveloperKey: os.Getenv(\"EPS_DEVELOPER_KEY\"),\n\t\tAccessKey: os.Getenv(\"EPS_ACCESS_KEY\"),\n\t\tInitiatorID: \"9962981729\",\n\t\tEnvironment: \"sandbox\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\tresult, err := client.Call(context.Background(), \"pan-lite\", map[string]any{\n\t\t\"pan_number\": \"ABCDE1234F\",\n\t\t\"name\": \"Rajesh Kumar\",\n\t\t\"dob\": \"1994-08-29\",\n\t})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Println(result)\n}"
|
|
24399
|
+
},
|
|
24400
|
+
{
|
|
24401
|
+
"lang": "java",
|
|
24402
|
+
"slug": "java",
|
|
24403
|
+
"title": "Java SDK",
|
|
24404
|
+
"summary": "Backend-only Java client for every EPS API, published from a git tag via JitPack, with HMAC signing built in.",
|
|
24405
|
+
"packageName": "com.github.ekoindia:eps-sdk-java",
|
|
24406
|
+
"installCommand": "com.github.ekoindia:eps-sdk-java",
|
|
24407
|
+
"registry": "JitPack",
|
|
24408
|
+
"registryUrl": "https://jitpack.io/#ekoindia/eps-sdk-java",
|
|
24409
|
+
"minRuntime": "Java 17 or newer",
|
|
24410
|
+
"dependencies": "One: Gson, because Java has no JSON parser in the standard library. HTTP uses the JDK's own `java.net.http`.",
|
|
24411
|
+
"sourceUrl": "https://github.com/ekoindia/eps-platform/tree/main/packages/sdk-java",
|
|
24412
|
+
"docsUrl": "https://eps.eko.in/docs/sdk/java",
|
|
24413
|
+
"installNotes": [
|
|
24414
|
+
"Published through JitPack from a git tag — add the JitPack repository alongside Maven Central.",
|
|
24415
|
+
"Gradle: `maven { url 'https://jitpack.io' }`, then `implementation 'com.github.ekoindia:eps-sdk-java:<tag>'`.",
|
|
24416
|
+
"Maven: a `<repository>` with id `jitpack.io` and url `https://jitpack.io`, then the `com.github.ekoindia:eps-sdk-java` dependency."
|
|
24417
|
+
],
|
|
24418
|
+
"config": [
|
|
24419
|
+
{
|
|
24420
|
+
"name": ".developerKey(…)",
|
|
24421
|
+
"type": "String",
|
|
24422
|
+
"required": true,
|
|
24423
|
+
"description": "Your EPS developer key, sent as the `developer_key` header."
|
|
24424
|
+
},
|
|
24425
|
+
{
|
|
24426
|
+
"name": ".accessKey(…)",
|
|
24427
|
+
"type": "String",
|
|
24428
|
+
"required": true,
|
|
24429
|
+
"description": "Server-side secret used to sign every request. Never ships to a browser."
|
|
24430
|
+
},
|
|
24431
|
+
{
|
|
24432
|
+
"name": ".environment(…)",
|
|
24433
|
+
"type": "\"sandbox\" | \"production\"",
|
|
24434
|
+
"required": true,
|
|
24435
|
+
"description": "Selects the base URL from the embedded surface."
|
|
24436
|
+
},
|
|
24437
|
+
{
|
|
24438
|
+
"name": ".initiatorId(…)",
|
|
24439
|
+
"type": "String",
|
|
24440
|
+
"required": false,
|
|
24441
|
+
"description": "Default `initiator_id` (registered mobile of the API user) injected into every call."
|
|
24442
|
+
},
|
|
24443
|
+
{
|
|
24444
|
+
"name": ".userCode(…)",
|
|
24445
|
+
"type": "String",
|
|
24446
|
+
"required": false,
|
|
24447
|
+
"description": "Default `user_code` (retailer/agent code) injected into every call."
|
|
24448
|
+
},
|
|
24449
|
+
{
|
|
24450
|
+
"name": ".httpClient(…)",
|
|
24451
|
+
"type": "HttpClient",
|
|
24452
|
+
"required": false,
|
|
24453
|
+
"units": "default: 30s connect + 30s per request",
|
|
24454
|
+
"description": "Control timeouts, proxies or redirects by supplying your own client."
|
|
24455
|
+
},
|
|
24456
|
+
{
|
|
24457
|
+
"name": ".retries(…)",
|
|
24458
|
+
"type": "int",
|
|
24459
|
+
"required": false,
|
|
24460
|
+
"units": "default 2",
|
|
24461
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24462
|
+
},
|
|
24463
|
+
{
|
|
24464
|
+
"name": ".retryBaseDelay(…)",
|
|
24465
|
+
"type": "Duration",
|
|
24466
|
+
"required": false,
|
|
24467
|
+
"units": "default 200ms",
|
|
24468
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24469
|
+
},
|
|
24470
|
+
{
|
|
24471
|
+
"name": ".autoStatusCheck(…)",
|
|
24472
|
+
"type": "boolean",
|
|
24473
|
+
"required": false,
|
|
24474
|
+
"units": "default true",
|
|
24475
|
+
"description": "After an indeterminate failure on a money-moving endpoint, look the transaction up by its `client_ref_id` and attach the result to the indeterminate error."
|
|
24476
|
+
}
|
|
24477
|
+
],
|
|
24478
|
+
"members": [
|
|
24479
|
+
{
|
|
24480
|
+
"kind": "class",
|
|
24481
|
+
"name": "in.eko.eps.EpsClient",
|
|
24482
|
+
"signature": "EpsClient.builder()…build()",
|
|
24483
|
+
"description": "The client, built through a fluent builder."
|
|
24484
|
+
},
|
|
24485
|
+
{
|
|
24486
|
+
"kind": "method",
|
|
24487
|
+
"name": "call",
|
|
24488
|
+
"signature": "client.call(String slug, Map<String, Object> params): Map<String, Object>",
|
|
24489
|
+
"description": "Validates, signs and sends one endpoint call; returns the decoded envelope."
|
|
24490
|
+
},
|
|
24491
|
+
{
|
|
24492
|
+
"kind": "method",
|
|
24493
|
+
"name": "resolveTarget",
|
|
24494
|
+
"signature": "client.resolveTarget(String slug, Map<String, Object> params): Target",
|
|
24495
|
+
"description": "The signed request for a call, without sending it."
|
|
24496
|
+
},
|
|
24497
|
+
{
|
|
24498
|
+
"kind": "method",
|
|
24499
|
+
"name": "buildHeaders",
|
|
24500
|
+
"signature": "client.buildHeaders(boolean multipart): Map<String, String>",
|
|
24501
|
+
"description": "The four auth headers for a single request."
|
|
24502
|
+
},
|
|
24503
|
+
{
|
|
24504
|
+
"kind": "method",
|
|
24505
|
+
"name": "sign",
|
|
24506
|
+
"signature": "EpsClient.sign(String accessKey, String timestamp): String",
|
|
24507
|
+
"description": "Static. The raw signing primitive, exposed for debugging."
|
|
24508
|
+
},
|
|
24509
|
+
{
|
|
24510
|
+
"kind": "type",
|
|
24511
|
+
"name": "EpsClient.EpsFile",
|
|
24512
|
+
"signature": "record EpsFile(String name, byte[] content)",
|
|
24513
|
+
"description": "An in-memory upload."
|
|
24514
|
+
},
|
|
24515
|
+
{
|
|
24516
|
+
"kind": "constant",
|
|
24517
|
+
"name": "EpsClient.MULTIPART_JSON_FIELD",
|
|
24518
|
+
"signature": "MULTIPART_JSON_FIELD = \"form-data\"",
|
|
24519
|
+
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
24520
|
+
},
|
|
24521
|
+
{
|
|
24522
|
+
"kind": "method",
|
|
24523
|
+
"name": "EpsClient.generateClientRefId",
|
|
24524
|
+
"signature": "static String generateClientRefId(long nowMs)",
|
|
24525
|
+
"description": "The 15-char `client_ref_id` generator `call()` uses for a non-GET call that did not supply one — exported so you can mint refs the same way."
|
|
24526
|
+
}
|
|
24527
|
+
],
|
|
24528
|
+
"errorTypes": [
|
|
24529
|
+
{
|
|
24530
|
+
"name": "EpsClient.EpsIndeterminateException",
|
|
24531
|
+
"when": "A money-moving (`financial`) non-GET call ended with no confirmed outcome — timeout, transport failure, HTTP 429/5xx. The SDK did not re-send it; it looked the transaction up by its `client_ref_id` and attached the result. Reconcile before retrying.",
|
|
24532
|
+
"fields": "`slug`, `clientRefId`, `status` (or null), `statusCheck`, `statusCheckError`, `getCause()`"
|
|
24533
|
+
},
|
|
24534
|
+
{
|
|
24535
|
+
"name": "EpsClient.EpsTransportException",
|
|
24536
|
+
"when": "The request produced no response at all (DNS, connect, TLS, timeout). Retried on GET; wraps the native error."
|
|
24537
|
+
},
|
|
24538
|
+
{
|
|
24539
|
+
"name": "EpsClient.EpsHttpException",
|
|
24540
|
+
"when": "Any non-2xx response.",
|
|
24541
|
+
"fields": "`status`, `url`, `body` (decoded envelope or null), `raw`"
|
|
24542
|
+
},
|
|
24543
|
+
{
|
|
24544
|
+
"name": "EpsClient.EpsException",
|
|
24545
|
+
"when": "Unknown slug, missing required param, wrong param type, transport failure, or a 2xx body that is not JSON. Unchecked — it extends `RuntimeException`."
|
|
24546
|
+
}
|
|
24547
|
+
],
|
|
24548
|
+
"fileValues": [
|
|
24549
|
+
"A `String` path, a `java.nio.file.Path`, or a `java.io.File`",
|
|
24550
|
+
"An `EpsClient.EpsFile(name, content)` for an in-memory upload"
|
|
24551
|
+
],
|
|
24552
|
+
"notes": [
|
|
24553
|
+
"Upload parts are sent as `application/octet-stream`; the MIME type is not sniffed.",
|
|
24554
|
+
"Gson is configured with `serializeNulls()` — required for wire conformance, since every other SDK keeps explicit nulls."
|
|
24555
|
+
],
|
|
24556
|
+
"example": "import in.eko.eps.EpsClient;\nimport java.util.Map;\n\nEpsClient client = EpsClient.builder()\n .developerKey(System.getenv(\"EPS_DEVELOPER_KEY\"))\n .accessKey(System.getenv(\"EPS_ACCESS_KEY\"))\n .initiatorId(\"9962981729\")\n .environment(\"sandbox\")\n .build();\n\nMap<String, Object> result = client.call(\"pan-lite\", Map.of(\n \"pan_number\", \"ABCDE1234F\",\n \"name\", \"Rajesh Kumar\",\n \"dob\", \"1994-08-29\"\n ));\nSystem.out.println(result);"
|
|
24557
|
+
}
|
|
23550
24558
|
]
|
|
23551
24559
|
}
|