@ekoindia/eps-context-mcp 0.1.24 → 0.1.26
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 +730 -105
- 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": "c109bedc",
|
|
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",
|
|
@@ -3678,6 +3716,196 @@
|
|
|
3678
3716
|
}
|
|
3679
3717
|
]
|
|
3680
3718
|
},
|
|
3719
|
+
{
|
|
3720
|
+
"slug": "aeps-fingpay-cash-withdrawal-otp",
|
|
3721
|
+
"productId": "aeps",
|
|
3722
|
+
"productName": "AePS Cashout",
|
|
3723
|
+
"name": "Cash Withdrawal OTP",
|
|
3724
|
+
"method": "POST",
|
|
3725
|
+
"path": "/customer/collection/aeps-fingpay/cash-withdrawal/otp/{customer_id}",
|
|
3726
|
+
"summary": "Generate the transaction OTP required before an AePS cash withdrawal above ₹5,000.",
|
|
3727
|
+
"category": "bc",
|
|
3728
|
+
"relevance": "H",
|
|
3729
|
+
"description": "Fingpay requires a fresh, transaction-scoped OTP for every cash withdrawal above **₹5,000**. Call this before Cash Withdrawal only when `amount` is greater than ₹5,000 — for ₹5,000 or less, skip it and call Cash Withdrawal directly.\n\nOn success the customer receives a 6-digit OTP by SMS on their Aadhaar-linked mobile, and the response returns `data.fp_transaction_id`. Send that id to Cash Withdrawal as `txn_otp_request_id`, and put the SMS OTP in the `otp` attribute of the PidOptions used to capture the customer's fingerprint. They are two different values, and Cash Withdrawal needs both. The id belongs to this one withdrawal attempt: generate a new one for every attempt and never reuse it.\n\nNo biometric capture happens in this call — it takes no `piddata`.",
|
|
3730
|
+
"bestFor": "BC agents and CSPs pre-authorising AePS cash withdrawals above ₹5,000",
|
|
3731
|
+
"docsUrl": "https://eps.eko.in/docs/aeps-fingpay-cash-withdrawal-otp",
|
|
3732
|
+
"headers": [
|
|
3733
|
+
{
|
|
3734
|
+
"name": "developer_key",
|
|
3735
|
+
"in": "header",
|
|
3736
|
+
"type": "string",
|
|
3737
|
+
"required": true,
|
|
3738
|
+
"description": "Static API key issued to your account after KYC."
|
|
3739
|
+
},
|
|
3740
|
+
{
|
|
3741
|
+
"name": "secret-key",
|
|
3742
|
+
"in": "header",
|
|
3743
|
+
"type": "string",
|
|
3744
|
+
"required": true,
|
|
3745
|
+
"description": "Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key)))."
|
|
3746
|
+
},
|
|
3747
|
+
{
|
|
3748
|
+
"name": "secret-key-timestamp",
|
|
3749
|
+
"in": "header",
|
|
3750
|
+
"type": "string",
|
|
3751
|
+
"required": true,
|
|
3752
|
+
"description": "Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time."
|
|
3753
|
+
},
|
|
3754
|
+
{
|
|
3755
|
+
"name": "content-type",
|
|
3756
|
+
"in": "header",
|
|
3757
|
+
"type": "string",
|
|
3758
|
+
"required": true,
|
|
3759
|
+
"description": "application/json",
|
|
3760
|
+
"example": "application/json"
|
|
3761
|
+
}
|
|
3762
|
+
],
|
|
3763
|
+
"requestParams": [
|
|
3764
|
+
{
|
|
3765
|
+
"name": "initiator_id",
|
|
3766
|
+
"type": "string",
|
|
3767
|
+
"required": true,
|
|
3768
|
+
"description": "Registered mobile number of the API user (see Platform Credentials).",
|
|
3769
|
+
"example": "9962981729",
|
|
3770
|
+
"in": "body"
|
|
3771
|
+
},
|
|
3772
|
+
{
|
|
3773
|
+
"name": "client_ref_id",
|
|
3774
|
+
"type": "string",
|
|
3775
|
+
"required": false,
|
|
3776
|
+
"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.",
|
|
3777
|
+
"example": "2026010100123456789",
|
|
3778
|
+
"format": "client-ref",
|
|
3779
|
+
"maxLength": 20,
|
|
3780
|
+
"in": "body"
|
|
3781
|
+
},
|
|
3782
|
+
{
|
|
3783
|
+
"name": "user_code",
|
|
3784
|
+
"type": "string",
|
|
3785
|
+
"required": true,
|
|
3786
|
+
"description": "Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your users",
|
|
3787
|
+
"example": "10000001",
|
|
3788
|
+
"in": "body"
|
|
3789
|
+
},
|
|
3790
|
+
{
|
|
3791
|
+
"name": "customer_id",
|
|
3792
|
+
"type": "string",
|
|
3793
|
+
"required": true,
|
|
3794
|
+
"description": "Customer's registered mobile number.",
|
|
3795
|
+
"example": "9000000000",
|
|
3796
|
+
"in": "path"
|
|
3797
|
+
},
|
|
3798
|
+
{
|
|
3799
|
+
"name": "bank_code",
|
|
3800
|
+
"type": "string",
|
|
3801
|
+
"required": false,
|
|
3802
|
+
"description": "Short bank code identifying the customer's Aadhaar-linked bank (e.g. `HDFC`, `SBIN`). Obtain from the bank list API. Recommended — send the same value you will use for the withdrawal.",
|
|
3803
|
+
"example": "HDFC",
|
|
3804
|
+
"in": "body"
|
|
3805
|
+
},
|
|
3806
|
+
{
|
|
3807
|
+
"name": "aadhar",
|
|
3808
|
+
"type": "string",
|
|
3809
|
+
"required": true,
|
|
3810
|
+
"description": "RSA-encrypted, Base64-encoded Aadhaar number of the customer — the same value you send to Cash Withdrawal. Encrypt the 12-digit Aadhaar with the Eko RSA public key using PKCS#1 v1.5 padding (Java's default `Cipher.getInstance(\"RSA\")`), then Base64-encode the ciphertext.",
|
|
3811
|
+
"example": "BASE64_ENCRYPTED_AADHAAR",
|
|
3812
|
+
"in": "body"
|
|
3813
|
+
},
|
|
3814
|
+
{
|
|
3815
|
+
"name": "latlong",
|
|
3816
|
+
"type": "string",
|
|
3817
|
+
"format": "lat-long",
|
|
3818
|
+
"required": true,
|
|
3819
|
+
"description": "GPS coordinates of the agent's device in 'latitude,longitude' format.",
|
|
3820
|
+
"example": "28.6139,77.2090",
|
|
3821
|
+
"in": "body"
|
|
3822
|
+
},
|
|
3823
|
+
{
|
|
3824
|
+
"name": "amount",
|
|
3825
|
+
"type": "number",
|
|
3826
|
+
"required": true,
|
|
3827
|
+
"description": "Withdrawal amount in Indian Rupees (integer) — the same amount you will send to Cash Withdrawal. Only call this API when it is above ₹5,000.",
|
|
3828
|
+
"example": 6000,
|
|
3829
|
+
"in": "body"
|
|
3830
|
+
}
|
|
3831
|
+
],
|
|
3832
|
+
"sampleRequest": {
|
|
3833
|
+
"initiator_id": "9962981729",
|
|
3834
|
+
"client_ref_id": "2026010100123456789",
|
|
3835
|
+
"user_code": "10000001",
|
|
3836
|
+
"bank_code": "HDFC",
|
|
3837
|
+
"aadhar": "BASE64_ENCRYPTED_AADHAAR",
|
|
3838
|
+
"latlong": "28.6139,77.2090",
|
|
3839
|
+
"amount": 6000
|
|
3840
|
+
},
|
|
3841
|
+
"responseFields": [
|
|
3842
|
+
{
|
|
3843
|
+
"name": "status",
|
|
3844
|
+
"type": "number",
|
|
3845
|
+
"description": "Primary success indicator (0 = success).",
|
|
3846
|
+
"example": 0
|
|
3847
|
+
},
|
|
3848
|
+
{
|
|
3849
|
+
"name": "message",
|
|
3850
|
+
"type": "string",
|
|
3851
|
+
"description": "Human-readable response / error message.",
|
|
3852
|
+
"example": "Verification successful"
|
|
3853
|
+
},
|
|
3854
|
+
{
|
|
3855
|
+
"name": "response_status_id",
|
|
3856
|
+
"type": "number",
|
|
3857
|
+
"description": "Granular status id; see the shared error-codes table.",
|
|
3858
|
+
"example": 0
|
|
3859
|
+
},
|
|
3860
|
+
{
|
|
3861
|
+
"name": "response_type_id",
|
|
3862
|
+
"type": "number",
|
|
3863
|
+
"description": "A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.",
|
|
3864
|
+
"example": 1388
|
|
3865
|
+
},
|
|
3866
|
+
{
|
|
3867
|
+
"name": "data",
|
|
3868
|
+
"type": "object",
|
|
3869
|
+
"description": "API-specific response payload.",
|
|
3870
|
+
"children": [
|
|
3871
|
+
{
|
|
3872
|
+
"name": "fp_transaction_id",
|
|
3873
|
+
"type": "string",
|
|
3874
|
+
"description": "OTP reference id for this one withdrawal attempt. Send it to Cash Withdrawal as `txn_otp_request_id`. It is NOT the OTP — the customer receives that by SMS.",
|
|
3875
|
+
"imp": true,
|
|
3876
|
+
"example": "FP2609010001234567"
|
|
3877
|
+
}
|
|
3878
|
+
]
|
|
3879
|
+
}
|
|
3880
|
+
],
|
|
3881
|
+
"sampleSuccessResponse": {
|
|
3882
|
+
"response_status_id": 0,
|
|
3883
|
+
"data": {
|
|
3884
|
+
"fp_transaction_id": "FP2609010001234567"
|
|
3885
|
+
},
|
|
3886
|
+
"response_type_id": 1459,
|
|
3887
|
+
"message": "OTP generated successfully. Use the reference ID for your transaction.",
|
|
3888
|
+
"status": 0
|
|
3889
|
+
},
|
|
3890
|
+
"errorScenarios": [
|
|
3891
|
+
{
|
|
3892
|
+
"scenario": "OTP generation failed — generic Fingpay failure. There are no OTP-specific error codes yet; `message` carries the gateway's reason",
|
|
3893
|
+
"statusCode": 200,
|
|
3894
|
+
"example": {
|
|
3895
|
+
"response_status_id": 1,
|
|
3896
|
+
"message": "<failure description from the Fingpay gateway>",
|
|
3897
|
+
"status": 1
|
|
3898
|
+
}
|
|
3899
|
+
}
|
|
3900
|
+
],
|
|
3901
|
+
"responseTypes": [
|
|
3902
|
+
{
|
|
3903
|
+
"id": 1459,
|
|
3904
|
+
"meaning": "OTP generated and sent to the customer by SMS — send `data.fp_transaction_id` as `txn_otp_request_id` to Cash Withdrawal",
|
|
3905
|
+
"next": "aeps-fingpay-cash-withdrawal"
|
|
3906
|
+
}
|
|
3907
|
+
]
|
|
3908
|
+
},
|
|
3681
3909
|
{
|
|
3682
3910
|
"slug": "aeps-fingpay-cash-withdrawal",
|
|
3683
3911
|
"productId": "aeps",
|
|
@@ -3688,7 +3916,7 @@
|
|
|
3688
3916
|
"summary": "Withdraw cash from any Aadhaar-linked bank account using biometric fingerprint authentication — no card or PIN required.",
|
|
3689
3917
|
"category": "bc",
|
|
3690
3918
|
"relevance": "H",
|
|
3691
|
-
"description": "Allows a customer to withdraw cash from their bank account at an agent/BC point by providing their Aadhaar number and a live fingerprint scan. The agent's biometric device captures a PID XML blob which is passed verbatim to this API. The customer's Aadhaar is RSA-encrypted before transmission. Requires the agent to have completed AePS Fingpay activation, the one-time eKYC (Send OTP → Verify OTP → Biometric), and the Daily KYC for the current day.\n\nTo capture the `piddata` PID block with an RDService-compliant fingerprint scanner, see the [Aadhaar Biometric Authentication guide](/docs/aadhaar-biometric-rdservice).",
|
|
3919
|
+
"description": "Allows a customer to withdraw cash from their bank account at an agent/BC point by providing their Aadhaar number and a live fingerprint scan. The agent's biometric device captures a PID XML blob which is passed verbatim to this API. The customer's Aadhaar is RSA-encrypted before transmission. Requires the agent to have completed AePS Fingpay activation, the one-time eKYC (Send OTP → Verify OTP → Biometric), and the Daily KYC for the current day.\n\n**Above ₹5,000 a transaction OTP is required.** First call Cash Withdrawal OTP, then send its `fp_transaction_id` here as `txn_otp_request_id`, and put the customer's 6-digit SMS OTP in the `otp` attribute of the PidOptions used for the fingerprint capture. For ₹5,000 or less, no OTP step is needed.\n\nTo capture the `piddata` PID block with an RDService-compliant fingerprint scanner, see the [Aadhaar Biometric Authentication guide](/docs/aadhaar-biometric-rdservice).",
|
|
3692
3920
|
"bestFor": "BC agents, CSPs, and kirana-store banking points enabling cardless cash withdrawal for rural customers",
|
|
3693
3921
|
"docsUrl": "https://eps.eko.in/docs/aeps-fingpay-cash-withdrawal",
|
|
3694
3922
|
"financial": true,
|
|
@@ -3736,8 +3964,10 @@
|
|
|
3736
3964
|
"name": "client_ref_id",
|
|
3737
3965
|
"type": "string",
|
|
3738
3966
|
"required": false,
|
|
3739
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
3967
|
+
"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
3968
|
"example": "2026010100123456789",
|
|
3969
|
+
"format": "client-ref",
|
|
3970
|
+
"maxLength": 20,
|
|
3741
3971
|
"in": "body"
|
|
3742
3972
|
},
|
|
3743
3973
|
{
|
|
@@ -3775,6 +4005,7 @@
|
|
|
3775
4005
|
{
|
|
3776
4006
|
"name": "latlong",
|
|
3777
4007
|
"type": "string",
|
|
4008
|
+
"format": "lat-long",
|
|
3778
4009
|
"required": true,
|
|
3779
4010
|
"description": "GPS coordinates of the transaction origin in 'latitude,longitude' format.",
|
|
3780
4011
|
"example": "28.6139,77.2090",
|
|
@@ -3784,7 +4015,7 @@
|
|
|
3784
4015
|
"name": "piddata",
|
|
3785
4016
|
"type": "string",
|
|
3786
4017
|
"required": true,
|
|
3787
|
-
"description": "PID data captured from the UIDAI-certified biometric device, as a raw XML string. Must use Data type='X' (XML, not Protobuf). DeviceInfo must include the 'mc' (device certificate) parameter. fType must be 2.",
|
|
4018
|
+
"description": "PID data captured from the UIDAI-certified biometric device, as a raw XML string. Must use Data type='X' (XML, not Protobuf). DeviceInfo must include the 'mc' (device certificate) parameter. fType must be 2. For an `amount` above ₹5,000, set the `otp` attribute of the PidOptions `<Opts>` element to the customer's 6-digit SMS OTP before capture — the OTP itself, not the `fp_transaction_id`.",
|
|
3788
4019
|
"example": "<?xml version='1.0'?><PidData><Data type='X'>...</Data><DeviceInfo mc='...' /></PidData>",
|
|
3789
4020
|
"in": "body"
|
|
3790
4021
|
},
|
|
@@ -3792,9 +4023,16 @@
|
|
|
3792
4023
|
"name": "amount",
|
|
3793
4024
|
"type": "number",
|
|
3794
4025
|
"required": true,
|
|
3795
|
-
"description": "Withdrawal amount in Indian Rupees (integer). Must be greater than 0 for cash withdrawal.",
|
|
4026
|
+
"description": "Withdrawal amount in Indian Rupees (integer). Must be greater than 0 for cash withdrawal. Above ₹5,000, call Cash Withdrawal OTP first and send `txn_otp_request_id`.",
|
|
3796
4027
|
"example": 1000,
|
|
3797
4028
|
"in": "body"
|
|
4029
|
+
},
|
|
4030
|
+
{
|
|
4031
|
+
"name": "txn_otp_request_id",
|
|
4032
|
+
"type": "string",
|
|
4033
|
+
"required": false,
|
|
4034
|
+
"description": "Required when `amount` is above ₹5,000: the `fp_transaction_id` returned by Cash Withdrawal OTP for this attempt (e.g. `FP2609010001234567`). Omit for ₹5,000 or less.",
|
|
4035
|
+
"in": "body"
|
|
3798
4036
|
}
|
|
3799
4037
|
],
|
|
3800
4038
|
"sampleRequest": {
|
|
@@ -4009,6 +4247,12 @@
|
|
|
4009
4247
|
"type": "string",
|
|
4010
4248
|
"description": "Human-readable transaction remark from the provider (e.g. 'Request Completed').",
|
|
4011
4249
|
"example": "Request Completed"
|
|
4250
|
+
},
|
|
4251
|
+
{
|
|
4252
|
+
"name": "fp_transaction_id",
|
|
4253
|
+
"type": "string",
|
|
4254
|
+
"description": "Returned only with `response_type_id` 1459 (OTP required — nothing was withdrawn): the OTP reference to send back as `txn_otp_request_id`.",
|
|
4255
|
+
"example": "FP2609010001234567"
|
|
4012
4256
|
}
|
|
4013
4257
|
]
|
|
4014
4258
|
}
|
|
@@ -4101,6 +4345,19 @@
|
|
|
4101
4345
|
"status": 1464
|
|
4102
4346
|
}
|
|
4103
4347
|
},
|
|
4348
|
+
{
|
|
4349
|
+
"scenario": "OTP required — `amount` above ₹5,000 sent without `txn_otp_request_id`. NOTHING was withdrawn: an OTP was sent to the customer instead",
|
|
4350
|
+
"statusCode": 200,
|
|
4351
|
+
"example": {
|
|
4352
|
+
"response_status_id": 0,
|
|
4353
|
+
"data": {
|
|
4354
|
+
"fp_transaction_id": "FP2609010001234567"
|
|
4355
|
+
},
|
|
4356
|
+
"response_type_id": 1459,
|
|
4357
|
+
"message": "OTP generated successfully. Use the reference ID for your transaction.",
|
|
4358
|
+
"status": 0
|
|
4359
|
+
}
|
|
4360
|
+
},
|
|
4104
4361
|
{
|
|
4105
4362
|
"scenario": "Transaction Pending — awaiting bank confirmation",
|
|
4106
4363
|
"statusCode": 200,
|
|
@@ -4143,12 +4400,16 @@
|
|
|
4143
4400
|
},
|
|
4144
4401
|
{
|
|
4145
4402
|
"id": 1464,
|
|
4146
|
-
"meaning": "Transaction Fail"
|
|
4403
|
+
"meaning": "Transaction Fail — above ₹5,000 this also covers an expired, invalid or already-used OTP (there is no separate code). Once the failure is final, generate a fresh OTP and re-capture before retrying"
|
|
4147
4404
|
},
|
|
4148
4405
|
{
|
|
4149
4406
|
"id": 1465,
|
|
4150
4407
|
"meaning": "Transaction Pending — check final status later",
|
|
4151
4408
|
"next": "transaction-inquiry"
|
|
4409
|
+
},
|
|
4410
|
+
{
|
|
4411
|
+
"id": 1459,
|
|
4412
|
+
"meaning": "OTP required — `amount` is above ₹5,000 but no `txn_otp_request_id` was sent. Nothing was withdrawn; an OTP was sent to the customer. Retry with `data.fp_transaction_id` as `txn_otp_request_id` and the customer's SMS OTP in the PidOptions `otp` attribute — do not generate another OTP"
|
|
4152
4413
|
}
|
|
4153
4414
|
]
|
|
4154
4415
|
},
|
|
@@ -4210,8 +4471,10 @@
|
|
|
4210
4471
|
"name": "client_ref_id",
|
|
4211
4472
|
"type": "string",
|
|
4212
4473
|
"required": false,
|
|
4213
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
4474
|
+
"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
4475
|
"example": "2026010100123456789",
|
|
4476
|
+
"format": "client-ref",
|
|
4477
|
+
"maxLength": 20,
|
|
4215
4478
|
"in": "body"
|
|
4216
4479
|
},
|
|
4217
4480
|
{
|
|
@@ -4249,6 +4512,7 @@
|
|
|
4249
4512
|
{
|
|
4250
4513
|
"name": "latlong",
|
|
4251
4514
|
"type": "string",
|
|
4515
|
+
"format": "lat-long",
|
|
4252
4516
|
"required": true,
|
|
4253
4517
|
"description": "GPS coordinates of the transaction origin in 'latitude,longitude' format.",
|
|
4254
4518
|
"example": "28.6139,77.2090",
|
|
@@ -4560,8 +4824,10 @@
|
|
|
4560
4824
|
"name": "client_ref_id",
|
|
4561
4825
|
"type": "string",
|
|
4562
4826
|
"required": false,
|
|
4563
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
4827
|
+
"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
4828
|
"example": "2026010100123456789",
|
|
4829
|
+
"format": "client-ref",
|
|
4830
|
+
"maxLength": 20,
|
|
4565
4831
|
"in": "body"
|
|
4566
4832
|
},
|
|
4567
4833
|
{
|
|
@@ -4599,6 +4865,7 @@
|
|
|
4599
4865
|
{
|
|
4600
4866
|
"name": "latlong",
|
|
4601
4867
|
"type": "string",
|
|
4868
|
+
"format": "lat-long",
|
|
4602
4869
|
"required": true,
|
|
4603
4870
|
"description": "GPS coordinates of the transaction origin in 'latitude,longitude' format.",
|
|
4604
4871
|
"example": "28.6139,77.2090",
|
|
@@ -4924,8 +5191,10 @@
|
|
|
4924
5191
|
"name": "client_ref_id",
|
|
4925
5192
|
"type": "string",
|
|
4926
5193
|
"required": false,
|
|
4927
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5194
|
+
"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
5195
|
"example": "2026010100123456789",
|
|
5196
|
+
"format": "client-ref",
|
|
5197
|
+
"maxLength": 20,
|
|
4929
5198
|
"in": "body"
|
|
4930
5199
|
},
|
|
4931
5200
|
{
|
|
@@ -4947,6 +5216,7 @@
|
|
|
4947
5216
|
{
|
|
4948
5217
|
"name": "ifsc",
|
|
4949
5218
|
"type": "string",
|
|
5219
|
+
"format": "ifsc",
|
|
4950
5220
|
"required": true,
|
|
4951
5221
|
"description": "IFSC code of the bank account.",
|
|
4952
5222
|
"example": "SBIN0000000",
|
|
@@ -5112,8 +5382,10 @@
|
|
|
5112
5382
|
"name": "client_ref_id",
|
|
5113
5383
|
"type": "string",
|
|
5114
5384
|
"required": false,
|
|
5115
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5385
|
+
"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
5386
|
"example": "2026010100123456789",
|
|
5387
|
+
"format": "client-ref",
|
|
5388
|
+
"maxLength": 20,
|
|
5117
5389
|
"in": "query"
|
|
5118
5390
|
},
|
|
5119
5391
|
{
|
|
@@ -5290,8 +5562,10 @@
|
|
|
5290
5562
|
"name": "client_ref_id",
|
|
5291
5563
|
"type": "string",
|
|
5292
5564
|
"required": false,
|
|
5293
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5565
|
+
"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
5566
|
"example": "2026010100123456789",
|
|
5567
|
+
"format": "client-ref",
|
|
5568
|
+
"maxLength": 20,
|
|
5295
5569
|
"in": "body"
|
|
5296
5570
|
},
|
|
5297
5571
|
{
|
|
@@ -5567,8 +5841,10 @@
|
|
|
5567
5841
|
"name": "client_ref_id",
|
|
5568
5842
|
"type": "string",
|
|
5569
5843
|
"required": false,
|
|
5570
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
5844
|
+
"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
5845
|
"example": "2026010100123456789",
|
|
5846
|
+
"format": "client-ref",
|
|
5847
|
+
"maxLength": 20,
|
|
5572
5848
|
"in": "query"
|
|
5573
5849
|
}
|
|
5574
5850
|
],
|
|
@@ -5748,8 +6024,10 @@
|
|
|
5748
6024
|
"name": "client_ref_id",
|
|
5749
6025
|
"type": "string",
|
|
5750
6026
|
"required": false,
|
|
5751
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6027
|
+
"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
6028
|
"example": "2026010100123456789",
|
|
6029
|
+
"format": "client-ref",
|
|
6030
|
+
"maxLength": 20,
|
|
5753
6031
|
"in": "query"
|
|
5754
6032
|
}
|
|
5755
6033
|
],
|
|
@@ -5914,8 +6192,10 @@
|
|
|
5914
6192
|
"name": "client_ref_id",
|
|
5915
6193
|
"type": "string",
|
|
5916
6194
|
"required": false,
|
|
5917
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6195
|
+
"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
6196
|
"example": "2026010100123456789",
|
|
6197
|
+
"format": "client-ref",
|
|
6198
|
+
"maxLength": 20,
|
|
5919
6199
|
"in": "query"
|
|
5920
6200
|
},
|
|
5921
6201
|
{
|
|
@@ -6141,8 +6421,10 @@
|
|
|
6141
6421
|
"name": "client_ref_id",
|
|
6142
6422
|
"type": "string",
|
|
6143
6423
|
"required": false,
|
|
6144
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6424
|
+
"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
6425
|
"example": "2026010100123456789",
|
|
6426
|
+
"format": "client-ref",
|
|
6427
|
+
"maxLength": 20,
|
|
6146
6428
|
"in": "query"
|
|
6147
6429
|
},
|
|
6148
6430
|
{
|
|
@@ -6363,8 +6645,10 @@
|
|
|
6363
6645
|
"name": "client_ref_id",
|
|
6364
6646
|
"type": "string",
|
|
6365
6647
|
"required": false,
|
|
6366
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6648
|
+
"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
6649
|
"example": "2026010100123456789",
|
|
6650
|
+
"format": "client-ref",
|
|
6651
|
+
"maxLength": 20,
|
|
6368
6652
|
"in": "query"
|
|
6369
6653
|
}
|
|
6370
6654
|
],
|
|
@@ -6539,8 +6823,10 @@
|
|
|
6539
6823
|
"name": "client_ref_id",
|
|
6540
6824
|
"type": "string",
|
|
6541
6825
|
"required": false,
|
|
6542
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6826
|
+
"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
6827
|
"example": "2026010100123456789",
|
|
6828
|
+
"format": "client-ref",
|
|
6829
|
+
"maxLength": 20,
|
|
6544
6830
|
"in": "query"
|
|
6545
6831
|
},
|
|
6546
6832
|
{
|
|
@@ -6691,8 +6977,10 @@
|
|
|
6691
6977
|
"name": "client_ref_id",
|
|
6692
6978
|
"type": "string",
|
|
6693
6979
|
"required": false,
|
|
6694
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
6980
|
+
"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
6981
|
"example": "2026010100123456789",
|
|
6982
|
+
"format": "client-ref",
|
|
6983
|
+
"maxLength": 20,
|
|
6696
6984
|
"in": "query"
|
|
6697
6985
|
},
|
|
6698
6986
|
{
|
|
@@ -7611,14 +7899,17 @@
|
|
|
7611
7899
|
"name": "client_ref_id",
|
|
7612
7900
|
"type": "string",
|
|
7613
7901
|
"required": false,
|
|
7614
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
7902
|
+
"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
7903
|
"example": "2026010100123456789",
|
|
7904
|
+
"format": "client-ref",
|
|
7905
|
+
"maxLength": 20,
|
|
7616
7906
|
"in": "body"
|
|
7617
7907
|
},
|
|
7618
7908
|
{
|
|
7619
7909
|
"name": "pan_number",
|
|
7620
7910
|
"label": "PAN Number",
|
|
7621
7911
|
"type": "string",
|
|
7912
|
+
"format": "pan",
|
|
7622
7913
|
"required": true,
|
|
7623
7914
|
"description": "10-character alphanumeric PAN identifier (5 letters, 4 digits, 1 letter).",
|
|
7624
7915
|
"example": "GGTPB7880Q",
|
|
@@ -7782,14 +8073,17 @@
|
|
|
7782
8073
|
"name": "client_ref_id",
|
|
7783
8074
|
"type": "string",
|
|
7784
8075
|
"required": false,
|
|
7785
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8076
|
+
"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
8077
|
"example": "2026010100123456789",
|
|
8078
|
+
"format": "client-ref",
|
|
8079
|
+
"maxLength": 20,
|
|
7787
8080
|
"in": "body"
|
|
7788
8081
|
},
|
|
7789
8082
|
{
|
|
7790
8083
|
"name": "pan_number",
|
|
7791
8084
|
"label": "PAN Number",
|
|
7792
8085
|
"type": "string",
|
|
8086
|
+
"format": "pan",
|
|
7793
8087
|
"required": true,
|
|
7794
8088
|
"description": "10-character alphanumeric PAN identifier (5 letters, 4 digits, 1 letter).",
|
|
7795
8089
|
"example": "ABCDE1234F",
|
|
@@ -7807,6 +8101,7 @@
|
|
|
7807
8101
|
"name": "dob",
|
|
7808
8102
|
"label": "Date of Birth",
|
|
7809
8103
|
"type": "string",
|
|
8104
|
+
"format": "date",
|
|
7810
8105
|
"required": true,
|
|
7811
8106
|
"description": "Date of birth in YYYY-MM-DD format.",
|
|
7812
8107
|
"example": "1994-08-29",
|
|
@@ -8023,14 +8318,17 @@
|
|
|
8023
8318
|
"name": "client_ref_id",
|
|
8024
8319
|
"type": "string",
|
|
8025
8320
|
"required": false,
|
|
8026
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8321
|
+
"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
8322
|
"example": "2026010100123456789",
|
|
8323
|
+
"format": "client-ref",
|
|
8324
|
+
"maxLength": 20,
|
|
8028
8325
|
"in": "body"
|
|
8029
8326
|
},
|
|
8030
8327
|
{
|
|
8031
8328
|
"name": "pan",
|
|
8032
8329
|
"label": "PAN Number",
|
|
8033
8330
|
"type": "string",
|
|
8331
|
+
"format": "pan",
|
|
8034
8332
|
"required": true,
|
|
8035
8333
|
"description": "10-character alphanumeric PAN identifier (first 5 alphabets, 4 digits, 1 alphabet).",
|
|
8036
8334
|
"example": "ABCDE1234F",
|
|
@@ -8326,8 +8624,10 @@
|
|
|
8326
8624
|
"name": "client_ref_id",
|
|
8327
8625
|
"type": "string",
|
|
8328
8626
|
"required": false,
|
|
8329
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8627
|
+
"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
8628
|
"example": "2026010100123456789",
|
|
8629
|
+
"format": "client-ref",
|
|
8630
|
+
"maxLength": 20,
|
|
8331
8631
|
"in": "body"
|
|
8332
8632
|
},
|
|
8333
8633
|
{
|
|
@@ -8491,8 +8791,10 @@
|
|
|
8491
8791
|
"name": "client_ref_id",
|
|
8492
8792
|
"type": "string",
|
|
8493
8793
|
"required": false,
|
|
8494
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
8794
|
+
"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
8795
|
"example": "2026010100123456789",
|
|
8796
|
+
"format": "client-ref",
|
|
8797
|
+
"maxLength": 20,
|
|
8496
8798
|
"in": "query"
|
|
8497
8799
|
},
|
|
8498
8800
|
{
|
|
@@ -8742,8 +9044,10 @@
|
|
|
8742
9044
|
"name": "client_ref_id",
|
|
8743
9045
|
"type": "string",
|
|
8744
9046
|
"required": false,
|
|
8745
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9047
|
+
"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
9048
|
"example": "2026010100123456789",
|
|
9049
|
+
"format": "client-ref",
|
|
9050
|
+
"maxLength": 20,
|
|
8747
9051
|
"in": "body"
|
|
8748
9052
|
},
|
|
8749
9053
|
{
|
|
@@ -8757,6 +9061,7 @@
|
|
|
8757
9061
|
{
|
|
8758
9062
|
"name": "aadhar",
|
|
8759
9063
|
"type": "string",
|
|
9064
|
+
"format": "aadhaar",
|
|
8760
9065
|
"required": true,
|
|
8761
9066
|
"description": "12-digit Aadhaar number of the sender.",
|
|
8762
9067
|
"example": "123456789012",
|
|
@@ -8913,8 +9218,10 @@
|
|
|
8913
9218
|
"name": "client_ref_id",
|
|
8914
9219
|
"type": "string",
|
|
8915
9220
|
"required": false,
|
|
8916
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9221
|
+
"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
9222
|
"example": "2026010100123456789",
|
|
9223
|
+
"format": "client-ref",
|
|
9224
|
+
"maxLength": 20,
|
|
8918
9225
|
"in": "body"
|
|
8919
9226
|
},
|
|
8920
9227
|
{
|
|
@@ -9128,8 +9435,10 @@
|
|
|
9128
9435
|
"name": "client_ref_id",
|
|
9129
9436
|
"type": "string",
|
|
9130
9437
|
"required": false,
|
|
9131
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9438
|
+
"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
9439
|
"example": "2026010100123456789",
|
|
9440
|
+
"format": "client-ref",
|
|
9441
|
+
"maxLength": 20,
|
|
9133
9442
|
"in": "query"
|
|
9134
9443
|
},
|
|
9135
9444
|
{
|
|
@@ -9280,8 +9589,10 @@
|
|
|
9280
9589
|
"name": "client_ref_id",
|
|
9281
9590
|
"type": "string",
|
|
9282
9591
|
"required": false,
|
|
9283
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9592
|
+
"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
9593
|
"example": "2026010100123456789",
|
|
9594
|
+
"format": "client-ref",
|
|
9595
|
+
"maxLength": 20,
|
|
9285
9596
|
"in": "body"
|
|
9286
9597
|
},
|
|
9287
9598
|
{
|
|
@@ -9303,6 +9614,7 @@
|
|
|
9303
9614
|
{
|
|
9304
9615
|
"name": "dob",
|
|
9305
9616
|
"type": "string",
|
|
9617
|
+
"format": "date",
|
|
9306
9618
|
"required": true,
|
|
9307
9619
|
"description": "Date of birth of the sender in YYYY-MM-DD format.",
|
|
9308
9620
|
"example": "1990-05-15",
|
|
@@ -9466,8 +9778,10 @@
|
|
|
9466
9778
|
"name": "client_ref_id",
|
|
9467
9779
|
"type": "string",
|
|
9468
9780
|
"required": false,
|
|
9469
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
9781
|
+
"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
9782
|
"example": "2026010100123456789",
|
|
9783
|
+
"format": "client-ref",
|
|
9784
|
+
"maxLength": 20,
|
|
9471
9785
|
"in": "body"
|
|
9472
9786
|
},
|
|
9473
9787
|
{
|
|
@@ -9784,8 +10098,10 @@
|
|
|
9784
10098
|
"name": "client_ref_id",
|
|
9785
10099
|
"type": "string",
|
|
9786
10100
|
"required": false,
|
|
9787
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10101
|
+
"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
10102
|
"example": "2026010100123456789",
|
|
10103
|
+
"format": "client-ref",
|
|
10104
|
+
"maxLength": 20,
|
|
9789
10105
|
"in": "body"
|
|
9790
10106
|
},
|
|
9791
10107
|
{
|
|
@@ -9799,6 +10115,7 @@
|
|
|
9799
10115
|
{
|
|
9800
10116
|
"name": "pan_number",
|
|
9801
10117
|
"type": "string",
|
|
10118
|
+
"format": "pan",
|
|
9802
10119
|
"required": false,
|
|
9803
10120
|
"description": "The PAN number of the sender.",
|
|
9804
10121
|
"example": "ABCDE1234F",
|
|
@@ -10008,8 +10325,10 @@
|
|
|
10008
10325
|
"name": "client_ref_id",
|
|
10009
10326
|
"type": "string",
|
|
10010
10327
|
"required": false,
|
|
10011
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10328
|
+
"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
10329
|
"example": "2026010100123456789",
|
|
10330
|
+
"format": "client-ref",
|
|
10331
|
+
"maxLength": 20,
|
|
10013
10332
|
"in": "query"
|
|
10014
10333
|
},
|
|
10015
10334
|
{
|
|
@@ -10262,8 +10581,10 @@
|
|
|
10262
10581
|
"name": "client_ref_id",
|
|
10263
10582
|
"type": "string",
|
|
10264
10583
|
"required": false,
|
|
10265
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10584
|
+
"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
10585
|
"example": "2026010100123456789",
|
|
10586
|
+
"format": "client-ref",
|
|
10587
|
+
"maxLength": 20,
|
|
10267
10588
|
"in": "body"
|
|
10268
10589
|
},
|
|
10269
10590
|
{
|
|
@@ -10317,6 +10638,7 @@
|
|
|
10317
10638
|
{
|
|
10318
10639
|
"name": "ifsc",
|
|
10319
10640
|
"type": "string",
|
|
10641
|
+
"format": "ifsc",
|
|
10320
10642
|
"required": true,
|
|
10321
10643
|
"description": "IFSC code of the recipient's bank branch.",
|
|
10322
10644
|
"example": "KKBK0000878",
|
|
@@ -10477,8 +10799,10 @@
|
|
|
10477
10799
|
"name": "client_ref_id",
|
|
10478
10800
|
"type": "string",
|
|
10479
10801
|
"required": false,
|
|
10480
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10802
|
+
"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
10803
|
"example": "2026010100123456789",
|
|
10804
|
+
"format": "client-ref",
|
|
10805
|
+
"maxLength": 20,
|
|
10482
10806
|
"in": "body"
|
|
10483
10807
|
},
|
|
10484
10808
|
{
|
|
@@ -10625,8 +10949,10 @@
|
|
|
10625
10949
|
"name": "client_ref_id",
|
|
10626
10950
|
"type": "string",
|
|
10627
10951
|
"required": false,
|
|
10628
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
10952
|
+
"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
10953
|
"example": "2026010100123456789",
|
|
10954
|
+
"format": "client-ref",
|
|
10955
|
+
"maxLength": 20,
|
|
10630
10956
|
"in": "body"
|
|
10631
10957
|
},
|
|
10632
10958
|
{
|
|
@@ -10789,8 +11115,10 @@
|
|
|
10789
11115
|
"name": "client_ref_id",
|
|
10790
11116
|
"type": "string",
|
|
10791
11117
|
"required": false,
|
|
10792
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11118
|
+
"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
11119
|
"example": "2026010100123456789",
|
|
11120
|
+
"format": "client-ref",
|
|
11121
|
+
"maxLength": 20,
|
|
10794
11122
|
"in": "body"
|
|
10795
11123
|
},
|
|
10796
11124
|
{
|
|
@@ -10868,6 +11196,7 @@
|
|
|
10868
11196
|
{
|
|
10869
11197
|
"name": "latlong",
|
|
10870
11198
|
"type": "string",
|
|
11199
|
+
"format": "lat-long",
|
|
10871
11200
|
"required": false,
|
|
10872
11201
|
"description": "Geographic coordinates of the user's location.",
|
|
10873
11202
|
"example": "28.63,77.22",
|
|
@@ -11129,8 +11458,10 @@
|
|
|
11129
11458
|
"name": "client_ref_id",
|
|
11130
11459
|
"type": "string",
|
|
11131
11460
|
"required": false,
|
|
11132
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11461
|
+
"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
11462
|
"example": "2026010100123456789",
|
|
11463
|
+
"format": "client-ref",
|
|
11464
|
+
"maxLength": 20,
|
|
11134
11465
|
"in": "query"
|
|
11135
11466
|
},
|
|
11136
11467
|
{
|
|
@@ -11281,8 +11612,10 @@
|
|
|
11281
11612
|
"name": "client_ref_id",
|
|
11282
11613
|
"type": "string",
|
|
11283
11614
|
"required": false,
|
|
11284
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11615
|
+
"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
11616
|
"example": "2026010100123456789",
|
|
11617
|
+
"format": "client-ref",
|
|
11618
|
+
"maxLength": 20,
|
|
11286
11619
|
"in": "body"
|
|
11287
11620
|
},
|
|
11288
11621
|
{
|
|
@@ -11304,6 +11637,7 @@
|
|
|
11304
11637
|
{
|
|
11305
11638
|
"name": "dob",
|
|
11306
11639
|
"type": "string",
|
|
11640
|
+
"format": "date",
|
|
11307
11641
|
"required": true,
|
|
11308
11642
|
"description": "Date of birth of the sender in YYYY-MM-DD format.",
|
|
11309
11643
|
"example": "1990-05-15",
|
|
@@ -11475,8 +11809,10 @@
|
|
|
11475
11809
|
"name": "client_ref_id",
|
|
11476
11810
|
"type": "string",
|
|
11477
11811
|
"required": false,
|
|
11478
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11812
|
+
"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
11813
|
"example": "2026010100123456789",
|
|
11814
|
+
"format": "client-ref",
|
|
11815
|
+
"maxLength": 20,
|
|
11480
11816
|
"in": "body"
|
|
11481
11817
|
},
|
|
11482
11818
|
{
|
|
@@ -11609,8 +11945,10 @@
|
|
|
11609
11945
|
"name": "client_ref_id",
|
|
11610
11946
|
"type": "string",
|
|
11611
11947
|
"required": false,
|
|
11612
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
11948
|
+
"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
11949
|
"example": "2026010100123456789",
|
|
11950
|
+
"format": "client-ref",
|
|
11951
|
+
"maxLength": 20,
|
|
11614
11952
|
"in": "body"
|
|
11615
11953
|
},
|
|
11616
11954
|
{
|
|
@@ -12228,8 +12566,10 @@
|
|
|
12228
12566
|
"name": "client_ref_id",
|
|
12229
12567
|
"type": "string",
|
|
12230
12568
|
"required": false,
|
|
12231
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12569
|
+
"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
12570
|
"example": "2026010100123456789",
|
|
12571
|
+
"format": "client-ref",
|
|
12572
|
+
"maxLength": 20,
|
|
12233
12573
|
"in": "body"
|
|
12234
12574
|
},
|
|
12235
12575
|
{
|
|
@@ -12243,6 +12583,7 @@
|
|
|
12243
12583
|
{
|
|
12244
12584
|
"name": "aadhar",
|
|
12245
12585
|
"type": "string",
|
|
12586
|
+
"format": "aadhaar",
|
|
12246
12587
|
"required": true,
|
|
12247
12588
|
"description": "12-digit Aadhaar number of the sender.",
|
|
12248
12589
|
"example": "123456789012",
|
|
@@ -12371,8 +12712,10 @@
|
|
|
12371
12712
|
"name": "client_ref_id",
|
|
12372
12713
|
"type": "string",
|
|
12373
12714
|
"required": false,
|
|
12374
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12715
|
+
"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
12716
|
"example": "2026010100123456789",
|
|
12717
|
+
"format": "client-ref",
|
|
12718
|
+
"maxLength": 20,
|
|
12376
12719
|
"in": "body"
|
|
12377
12720
|
},
|
|
12378
12721
|
{
|
|
@@ -12514,8 +12857,10 @@
|
|
|
12514
12857
|
"name": "client_ref_id",
|
|
12515
12858
|
"type": "string",
|
|
12516
12859
|
"required": false,
|
|
12517
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
12860
|
+
"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
12861
|
"example": "2026010100123456789",
|
|
12862
|
+
"format": "client-ref",
|
|
12863
|
+
"maxLength": 20,
|
|
12519
12864
|
"in": "body"
|
|
12520
12865
|
},
|
|
12521
12866
|
{
|
|
@@ -12529,6 +12874,7 @@
|
|
|
12529
12874
|
{
|
|
12530
12875
|
"name": "pan_number",
|
|
12531
12876
|
"type": "string",
|
|
12877
|
+
"format": "pan",
|
|
12532
12878
|
"required": true,
|
|
12533
12879
|
"description": "The PAN number of the sender.",
|
|
12534
12880
|
"example": "ABCDE1234F",
|
|
@@ -12708,8 +13054,10 @@
|
|
|
12708
13054
|
"name": "client_ref_id",
|
|
12709
13055
|
"type": "string",
|
|
12710
13056
|
"required": false,
|
|
12711
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13057
|
+
"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
13058
|
"example": "2026010100123456789",
|
|
13059
|
+
"format": "client-ref",
|
|
13060
|
+
"maxLength": 20,
|
|
12713
13061
|
"in": "body"
|
|
12714
13062
|
},
|
|
12715
13063
|
{
|
|
@@ -12862,8 +13210,10 @@
|
|
|
12862
13210
|
"name": "client_ref_id",
|
|
12863
13211
|
"type": "string",
|
|
12864
13212
|
"required": false,
|
|
12865
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13213
|
+
"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
13214
|
"example": "2026010100123456789",
|
|
13215
|
+
"format": "client-ref",
|
|
13216
|
+
"maxLength": 20,
|
|
12867
13217
|
"in": "query"
|
|
12868
13218
|
},
|
|
12869
13219
|
{
|
|
@@ -13096,8 +13446,10 @@
|
|
|
13096
13446
|
"name": "client_ref_id",
|
|
13097
13447
|
"type": "string",
|
|
13098
13448
|
"required": false,
|
|
13099
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13449
|
+
"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
13450
|
"example": "2026010100123456789",
|
|
13451
|
+
"format": "client-ref",
|
|
13452
|
+
"maxLength": 20,
|
|
13101
13453
|
"in": "body"
|
|
13102
13454
|
},
|
|
13103
13455
|
{
|
|
@@ -13278,8 +13630,10 @@
|
|
|
13278
13630
|
"name": "client_ref_id",
|
|
13279
13631
|
"type": "string",
|
|
13280
13632
|
"required": false,
|
|
13281
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13633
|
+
"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
13634
|
"example": "2026010100123456789",
|
|
13635
|
+
"format": "client-ref",
|
|
13636
|
+
"maxLength": 20,
|
|
13283
13637
|
"in": "body"
|
|
13284
13638
|
},
|
|
13285
13639
|
{
|
|
@@ -13425,8 +13779,10 @@
|
|
|
13425
13779
|
"name": "client_ref_id",
|
|
13426
13780
|
"type": "string",
|
|
13427
13781
|
"required": false,
|
|
13428
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13782
|
+
"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
13783
|
"example": "2026010100123456789",
|
|
13784
|
+
"format": "client-ref",
|
|
13785
|
+
"maxLength": 20,
|
|
13430
13786
|
"in": "body"
|
|
13431
13787
|
},
|
|
13432
13788
|
{
|
|
@@ -13568,8 +13924,10 @@
|
|
|
13568
13924
|
"name": "client_ref_id",
|
|
13569
13925
|
"type": "string",
|
|
13570
13926
|
"required": false,
|
|
13571
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
13927
|
+
"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
13928
|
"example": "2026010100123456789",
|
|
13929
|
+
"format": "client-ref",
|
|
13930
|
+
"maxLength": 20,
|
|
13573
13931
|
"in": "body"
|
|
13574
13932
|
},
|
|
13575
13933
|
{
|
|
@@ -13732,8 +14090,10 @@
|
|
|
13732
14090
|
"name": "client_ref_id",
|
|
13733
14091
|
"type": "string",
|
|
13734
14092
|
"required": false,
|
|
13735
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14093
|
+
"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
14094
|
"example": "2026010100123456789",
|
|
14095
|
+
"format": "client-ref",
|
|
14096
|
+
"maxLength": 20,
|
|
13737
14097
|
"in": "body"
|
|
13738
14098
|
},
|
|
13739
14099
|
{
|
|
@@ -13819,6 +14179,7 @@
|
|
|
13819
14179
|
{
|
|
13820
14180
|
"name": "latlong",
|
|
13821
14181
|
"type": "string",
|
|
14182
|
+
"format": "lat-long",
|
|
13822
14183
|
"required": false,
|
|
13823
14184
|
"description": "Geographic coordinates of the user's location.",
|
|
13824
14185
|
"example": "28.63,77.22",
|
|
@@ -14066,13 +14427,16 @@
|
|
|
14066
14427
|
"name": "client_ref_id",
|
|
14067
14428
|
"type": "string",
|
|
14068
14429
|
"required": false,
|
|
14069
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14430
|
+
"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
14431
|
"example": "2026010100123456789",
|
|
14432
|
+
"format": "client-ref",
|
|
14433
|
+
"maxLength": 20,
|
|
14071
14434
|
"in": "body"
|
|
14072
14435
|
},
|
|
14073
14436
|
{
|
|
14074
14437
|
"name": "pan_number",
|
|
14075
14438
|
"type": "string",
|
|
14439
|
+
"format": "pan",
|
|
14076
14440
|
"required": true,
|
|
14077
14441
|
"description": "PAN card number of the agent.",
|
|
14078
14442
|
"example": "ABCDE1234F",
|
|
@@ -14128,6 +14492,7 @@
|
|
|
14128
14492
|
{
|
|
14129
14493
|
"name": "dob",
|
|
14130
14494
|
"type": "string",
|
|
14495
|
+
"format": "date",
|
|
14131
14496
|
"required": true,
|
|
14132
14497
|
"description": "Date of birth of the agent in YYYY-MM-DD format.",
|
|
14133
14498
|
"example": "1990-05-15",
|
|
@@ -14277,8 +14642,10 @@
|
|
|
14277
14642
|
"name": "client_ref_id",
|
|
14278
14643
|
"type": "string",
|
|
14279
14644
|
"required": false,
|
|
14280
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14645
|
+
"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
14646
|
"example": "2026010100123456789",
|
|
14647
|
+
"format": "client-ref",
|
|
14648
|
+
"maxLength": 20,
|
|
14282
14649
|
"in": "body"
|
|
14283
14650
|
},
|
|
14284
14651
|
{
|
|
@@ -14401,8 +14768,10 @@
|
|
|
14401
14768
|
"name": "client_ref_id",
|
|
14402
14769
|
"type": "string",
|
|
14403
14770
|
"required": false,
|
|
14404
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14771
|
+
"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
14772
|
"example": "2026010100123456789",
|
|
14773
|
+
"format": "client-ref",
|
|
14774
|
+
"maxLength": 20,
|
|
14406
14775
|
"in": "body"
|
|
14407
14776
|
},
|
|
14408
14777
|
{
|
|
@@ -14525,8 +14894,10 @@
|
|
|
14525
14894
|
"name": "client_ref_id",
|
|
14526
14895
|
"type": "string",
|
|
14527
14896
|
"required": false,
|
|
14528
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
14897
|
+
"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
14898
|
"example": "2026010100123456789",
|
|
14899
|
+
"format": "client-ref",
|
|
14900
|
+
"maxLength": 20,
|
|
14530
14901
|
"in": "query"
|
|
14531
14902
|
},
|
|
14532
14903
|
{
|
|
@@ -14720,8 +15091,10 @@
|
|
|
14720
15091
|
"name": "client_ref_id",
|
|
14721
15092
|
"type": "string",
|
|
14722
15093
|
"required": false,
|
|
14723
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15094
|
+
"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
15095
|
"example": "2026010100123456789",
|
|
15096
|
+
"format": "client-ref",
|
|
15097
|
+
"maxLength": 20,
|
|
14725
15098
|
"in": "query"
|
|
14726
15099
|
}
|
|
14727
15100
|
],
|
|
@@ -14877,8 +15250,10 @@
|
|
|
14877
15250
|
"name": "client_ref_id",
|
|
14878
15251
|
"type": "string",
|
|
14879
15252
|
"required": false,
|
|
14880
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15253
|
+
"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
15254
|
"example": "2026010100123456789",
|
|
15255
|
+
"format": "client-ref",
|
|
15256
|
+
"maxLength": 20,
|
|
14882
15257
|
"in": "query"
|
|
14883
15258
|
},
|
|
14884
15259
|
{
|
|
@@ -15023,8 +15398,10 @@
|
|
|
15023
15398
|
"name": "client_ref_id",
|
|
15024
15399
|
"type": "string",
|
|
15025
15400
|
"required": false,
|
|
15026
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15401
|
+
"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
15402
|
"example": "2026010100123456789",
|
|
15403
|
+
"format": "client-ref",
|
|
15404
|
+
"maxLength": 20,
|
|
15028
15405
|
"in": "query"
|
|
15029
15406
|
},
|
|
15030
15407
|
{
|
|
@@ -15528,8 +15905,10 @@
|
|
|
15528
15905
|
"name": "client_ref_id",
|
|
15529
15906
|
"type": "string",
|
|
15530
15907
|
"required": false,
|
|
15531
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
15908
|
+
"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
15909
|
"example": "2026010100123456789",
|
|
15910
|
+
"format": "client-ref",
|
|
15911
|
+
"maxLength": 20,
|
|
15533
15912
|
"in": "query"
|
|
15534
15913
|
}
|
|
15535
15914
|
],
|
|
@@ -15627,8 +16006,10 @@
|
|
|
15627
16006
|
"name": "client_ref_id",
|
|
15628
16007
|
"type": "string",
|
|
15629
16008
|
"required": false,
|
|
15630
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16009
|
+
"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
16010
|
"example": "2026010100123456789",
|
|
16011
|
+
"format": "client-ref",
|
|
16012
|
+
"maxLength": 20,
|
|
15632
16013
|
"in": "query"
|
|
15633
16014
|
},
|
|
15634
16015
|
{
|
|
@@ -15642,6 +16023,7 @@
|
|
|
15642
16023
|
{
|
|
15643
16024
|
"name": "ifsc",
|
|
15644
16025
|
"type": "string",
|
|
16026
|
+
"format": "ifsc",
|
|
15645
16027
|
"required": false,
|
|
15646
16028
|
"description": "IFSC code to narrow the lookup.",
|
|
15647
16029
|
"example": "IDFB0080202",
|
|
@@ -15800,13 +16182,16 @@
|
|
|
15800
16182
|
"name": "client_ref_id",
|
|
15801
16183
|
"type": "string",
|
|
15802
16184
|
"required": false,
|
|
15803
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16185
|
+
"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
16186
|
"example": "2026010100123456789",
|
|
16187
|
+
"format": "client-ref",
|
|
16188
|
+
"maxLength": 20,
|
|
15805
16189
|
"in": "query"
|
|
15806
16190
|
},
|
|
15807
16191
|
{
|
|
15808
16192
|
"name": "ifsc",
|
|
15809
16193
|
"type": "string",
|
|
16194
|
+
"format": "ifsc",
|
|
15810
16195
|
"required": true,
|
|
15811
16196
|
"description": "IFSC code of the bank branch.",
|
|
15812
16197
|
"example": "IOBA0002248",
|
|
@@ -15955,8 +16340,10 @@
|
|
|
15955
16340
|
"name": "client_ref_id",
|
|
15956
16341
|
"type": "string",
|
|
15957
16342
|
"required": false,
|
|
15958
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16343
|
+
"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
16344
|
"example": "2026010100123456789",
|
|
16345
|
+
"format": "client-ref",
|
|
16346
|
+
"maxLength": 20,
|
|
15960
16347
|
"in": "body"
|
|
15961
16348
|
},
|
|
15962
16349
|
{
|
|
@@ -16136,8 +16523,10 @@
|
|
|
16136
16523
|
"name": "client_ref_id",
|
|
16137
16524
|
"type": "string",
|
|
16138
16525
|
"required": false,
|
|
16139
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16526
|
+
"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
16527
|
"example": "2026010100123456789",
|
|
16528
|
+
"format": "client-ref",
|
|
16529
|
+
"maxLength": 20,
|
|
16141
16530
|
"in": "body"
|
|
16142
16531
|
},
|
|
16143
16532
|
{
|
|
@@ -16433,8 +16822,10 @@
|
|
|
16433
16822
|
"name": "client_ref_id",
|
|
16434
16823
|
"type": "string",
|
|
16435
16824
|
"required": false,
|
|
16436
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
16825
|
+
"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
16826
|
"example": "2026010100123456789",
|
|
16827
|
+
"format": "client-ref",
|
|
16828
|
+
"maxLength": 20,
|
|
16438
16829
|
"in": "query"
|
|
16439
16830
|
},
|
|
16440
16831
|
{
|
|
@@ -16647,8 +17038,10 @@
|
|
|
16647
17038
|
"name": "client_ref_id",
|
|
16648
17039
|
"type": "string",
|
|
16649
17040
|
"required": false,
|
|
16650
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17041
|
+
"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
17042
|
"example": "2026010100123456789",
|
|
17043
|
+
"format": "client-ref",
|
|
17044
|
+
"maxLength": 20,
|
|
16652
17045
|
"in": "body"
|
|
16653
17046
|
},
|
|
16654
17047
|
{
|
|
@@ -16656,24 +17049,25 @@
|
|
|
16656
17049
|
"type": "number",
|
|
16657
17050
|
"required": true,
|
|
16658
17051
|
"description": "Complete bank account number to be verified.",
|
|
16659
|
-
"example":
|
|
17052
|
+
"example": "026291800001191",
|
|
16660
17053
|
"in": "body"
|
|
16661
17054
|
},
|
|
16662
17055
|
{
|
|
16663
17056
|
"name": "ifsc",
|
|
16664
17057
|
"label": "IFSC Code",
|
|
16665
17058
|
"type": "string",
|
|
17059
|
+
"format": "ifsc",
|
|
16666
17060
|
"required": true,
|
|
16667
17061
|
"description": "IFSC code of the bank account to be verified (11-character alphanumeric).",
|
|
16668
|
-
"example": "
|
|
17062
|
+
"example": "YESB0000262",
|
|
16669
17063
|
"in": "body"
|
|
16670
17064
|
}
|
|
16671
17065
|
],
|
|
16672
17066
|
"sampleRequest": {
|
|
16673
17067
|
"initiator_id": "9962981729",
|
|
16674
17068
|
"client_ref_id": "2026010100123456789",
|
|
16675
|
-
"bank_account":
|
|
16676
|
-
"ifsc": "
|
|
17069
|
+
"bank_account": "026291800001191",
|
|
17070
|
+
"ifsc": "YESB0000262"
|
|
16677
17071
|
},
|
|
16678
17072
|
"responseFields": [
|
|
16679
17073
|
{
|
|
@@ -16882,8 +17276,10 @@
|
|
|
16882
17276
|
"name": "client_ref_id",
|
|
16883
17277
|
"type": "string",
|
|
16884
17278
|
"required": false,
|
|
16885
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17279
|
+
"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
17280
|
"example": "2026010100123456789",
|
|
17281
|
+
"format": "client-ref",
|
|
17282
|
+
"maxLength": 20,
|
|
16887
17283
|
"in": "body"
|
|
16888
17284
|
},
|
|
16889
17285
|
{
|
|
@@ -16899,6 +17295,7 @@
|
|
|
16899
17295
|
"name": "ifsc",
|
|
16900
17296
|
"label": "IFSC Code",
|
|
16901
17297
|
"type": "string",
|
|
17298
|
+
"format": "ifsc",
|
|
16902
17299
|
"required": true,
|
|
16903
17300
|
"description": "IFSC code of the bank account to be verified (11-character alphanumeric).",
|
|
16904
17301
|
"example": "SBIN0007515",
|
|
@@ -17052,8 +17449,10 @@
|
|
|
17052
17449
|
"name": "client_ref_id",
|
|
17053
17450
|
"type": "string",
|
|
17054
17451
|
"required": false,
|
|
17055
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17452
|
+
"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
17453
|
"example": "2026010100123456789",
|
|
17454
|
+
"format": "client-ref",
|
|
17455
|
+
"maxLength": 20,
|
|
17057
17456
|
"in": "body"
|
|
17058
17457
|
},
|
|
17059
17458
|
{
|
|
@@ -17256,8 +17655,10 @@
|
|
|
17256
17655
|
"name": "client_ref_id",
|
|
17257
17656
|
"type": "string",
|
|
17258
17657
|
"required": false,
|
|
17259
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17658
|
+
"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
17659
|
"example": "2026010100123456789",
|
|
17660
|
+
"format": "client-ref",
|
|
17661
|
+
"maxLength": 20,
|
|
17261
17662
|
"in": "query"
|
|
17262
17663
|
},
|
|
17263
17664
|
{
|
|
@@ -17482,8 +17883,10 @@
|
|
|
17482
17883
|
"name": "client_ref_id",
|
|
17483
17884
|
"type": "string",
|
|
17484
17885
|
"required": false,
|
|
17485
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
17886
|
+
"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
17887
|
"example": "2026010100123456789",
|
|
17888
|
+
"format": "client-ref",
|
|
17889
|
+
"maxLength": 20,
|
|
17487
17890
|
"in": "body"
|
|
17488
17891
|
},
|
|
17489
17892
|
{
|
|
@@ -17902,13 +18305,16 @@
|
|
|
17902
18305
|
"name": "client_ref_id",
|
|
17903
18306
|
"type": "string",
|
|
17904
18307
|
"required": false,
|
|
17905
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
18308
|
+
"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
18309
|
"example": "2026010100123456789",
|
|
18310
|
+
"format": "client-ref",
|
|
18311
|
+
"maxLength": 20,
|
|
17907
18312
|
"in": "body"
|
|
17908
18313
|
},
|
|
17909
18314
|
{
|
|
17910
18315
|
"name": "pan",
|
|
17911
18316
|
"type": "string",
|
|
18317
|
+
"format": "pan",
|
|
17912
18318
|
"required": true,
|
|
17913
18319
|
"description": "10-character alphanumeric PAN of the business or individual (5 letters, 4 digits, 1 letter).",
|
|
17914
18320
|
"example": "ABCDE1234F",
|
|
@@ -18111,8 +18517,10 @@
|
|
|
18111
18517
|
"name": "client_ref_id",
|
|
18112
18518
|
"type": "string",
|
|
18113
18519
|
"required": false,
|
|
18114
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
18520
|
+
"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
18521
|
"example": "2026010100123456789",
|
|
18522
|
+
"format": "client-ref",
|
|
18523
|
+
"maxLength": 20,
|
|
18116
18524
|
"in": "body"
|
|
18117
18525
|
},
|
|
18118
18526
|
{
|
|
@@ -18143,6 +18551,7 @@
|
|
|
18143
18551
|
{
|
|
18144
18552
|
"name": "latlong",
|
|
18145
18553
|
"type": "string",
|
|
18554
|
+
"format": "lat-long",
|
|
18146
18555
|
"required": true,
|
|
18147
18556
|
"description": "Geo-coordinates of the request origination point (latitude,longitude).",
|
|
18148
18557
|
"example": "28.6139,77.2090",
|
|
@@ -18338,8 +18747,10 @@
|
|
|
18338
18747
|
"name": "client_ref_id",
|
|
18339
18748
|
"type": "string",
|
|
18340
18749
|
"required": false,
|
|
18341
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
18750
|
+
"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
18751
|
"example": "2026010100123456789",
|
|
18752
|
+
"format": "client-ref",
|
|
18753
|
+
"maxLength": 20,
|
|
18343
18754
|
"in": "body"
|
|
18344
18755
|
},
|
|
18345
18756
|
{
|
|
@@ -18353,6 +18764,7 @@
|
|
|
18353
18764
|
{
|
|
18354
18765
|
"name": "dob",
|
|
18355
18766
|
"type": "string",
|
|
18767
|
+
"format": "date",
|
|
18356
18768
|
"required": true,
|
|
18357
18769
|
"description": "Date of birth of the DL holder in YYYY-MM-DD format. Used to cross-validate the license.",
|
|
18358
18770
|
"example": "1994-08-05",
|
|
@@ -18795,8 +19207,10 @@
|
|
|
18795
19207
|
"name": "client_ref_id",
|
|
18796
19208
|
"type": "string",
|
|
18797
19209
|
"required": false,
|
|
18798
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
19210
|
+
"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
19211
|
"example": "2026010100123456789",
|
|
19212
|
+
"format": "client-ref",
|
|
19213
|
+
"maxLength": 20,
|
|
18800
19214
|
"in": "body"
|
|
18801
19215
|
},
|
|
18802
19216
|
{
|
|
@@ -19516,8 +19930,10 @@
|
|
|
19516
19930
|
"name": "client_ref_id",
|
|
19517
19931
|
"type": "string",
|
|
19518
19932
|
"required": false,
|
|
19519
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
19933
|
+
"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
19934
|
"example": "2026010100123456789",
|
|
19935
|
+
"format": "client-ref",
|
|
19936
|
+
"maxLength": 20,
|
|
19521
19937
|
"in": "body"
|
|
19522
19938
|
},
|
|
19523
19939
|
{
|
|
@@ -20120,8 +20536,10 @@
|
|
|
20120
20536
|
"name": "client_ref_id",
|
|
20121
20537
|
"type": "string",
|
|
20122
20538
|
"required": false,
|
|
20123
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
20539
|
+
"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
20540
|
"example": "2026010100123456789",
|
|
20541
|
+
"format": "client-ref",
|
|
20542
|
+
"maxLength": 20,
|
|
20125
20543
|
"in": "body"
|
|
20126
20544
|
},
|
|
20127
20545
|
{
|
|
@@ -20355,8 +20773,10 @@
|
|
|
20355
20773
|
"name": "client_ref_id",
|
|
20356
20774
|
"type": "string",
|
|
20357
20775
|
"required": false,
|
|
20358
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
20776
|
+
"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
20777
|
"example": "2026010100123456789",
|
|
20778
|
+
"format": "client-ref",
|
|
20779
|
+
"maxLength": 20,
|
|
20360
20780
|
"in": "body"
|
|
20361
20781
|
},
|
|
20362
20782
|
{
|
|
@@ -20737,8 +21157,10 @@
|
|
|
20737
21157
|
"name": "client_ref_id",
|
|
20738
21158
|
"type": "string",
|
|
20739
21159
|
"required": false,
|
|
20740
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21160
|
+
"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
21161
|
"example": "2026010100123456789",
|
|
21162
|
+
"format": "client-ref",
|
|
21163
|
+
"maxLength": 20,
|
|
20742
21164
|
"in": "body"
|
|
20743
21165
|
},
|
|
20744
21166
|
{
|
|
@@ -20752,6 +21174,7 @@
|
|
|
20752
21174
|
{
|
|
20753
21175
|
"name": "dob",
|
|
20754
21176
|
"type": "string",
|
|
21177
|
+
"format": "date",
|
|
20755
21178
|
"required": true,
|
|
20756
21179
|
"description": "Date of birth of the passport holder in YYYY-MM-DD format.",
|
|
20757
21180
|
"example": "1994-08-29",
|
|
@@ -20948,8 +21371,10 @@
|
|
|
20948
21371
|
"name": "client_ref_id",
|
|
20949
21372
|
"type": "string",
|
|
20950
21373
|
"required": false,
|
|
20951
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21374
|
+
"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
21375
|
"example": "2026010100123456789",
|
|
21376
|
+
"format": "client-ref",
|
|
21377
|
+
"maxLength": 20,
|
|
20953
21378
|
"in": "body"
|
|
20954
21379
|
},
|
|
20955
21380
|
{
|
|
@@ -21227,8 +21652,10 @@
|
|
|
21227
21652
|
"name": "client_ref_id",
|
|
21228
21653
|
"type": "string",
|
|
21229
21654
|
"required": false,
|
|
21230
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21655
|
+
"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
21656
|
"example": "2026010100123456789",
|
|
21657
|
+
"format": "client-ref",
|
|
21658
|
+
"maxLength": 20,
|
|
21232
21659
|
"in": "body"
|
|
21233
21660
|
},
|
|
21234
21661
|
{
|
|
@@ -21439,8 +21866,10 @@
|
|
|
21439
21866
|
"name": "client_ref_id",
|
|
21440
21867
|
"type": "string",
|
|
21441
21868
|
"required": false,
|
|
21442
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
21869
|
+
"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
21870
|
"example": "2026010100123456789",
|
|
21871
|
+
"format": "client-ref",
|
|
21872
|
+
"maxLength": 20,
|
|
21444
21873
|
"in": "body"
|
|
21445
21874
|
},
|
|
21446
21875
|
{
|
|
@@ -21633,13 +22062,16 @@
|
|
|
21633
22062
|
"name": "client_ref_id",
|
|
21634
22063
|
"type": "string",
|
|
21635
22064
|
"required": false,
|
|
21636
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22065
|
+
"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
22066
|
"example": "2026010100123456789",
|
|
22067
|
+
"format": "client-ref",
|
|
22068
|
+
"maxLength": 20,
|
|
21638
22069
|
"in": "body"
|
|
21639
22070
|
},
|
|
21640
22071
|
{
|
|
21641
22072
|
"name": "pan_number",
|
|
21642
22073
|
"type": "string",
|
|
22074
|
+
"format": "pan",
|
|
21643
22075
|
"required": true,
|
|
21644
22076
|
"description": "PAN number of the individual or entity to check for ITR compliance (10-character alphanumeric, e.g. ABCDE1234F).",
|
|
21645
22077
|
"example": "ABCDE1234F",
|
|
@@ -21878,8 +22310,10 @@
|
|
|
21878
22310
|
"name": "client_ref_id",
|
|
21879
22311
|
"type": "string",
|
|
21880
22312
|
"required": false,
|
|
21881
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22313
|
+
"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
22314
|
"example": "2026010100123456789",
|
|
22315
|
+
"format": "client-ref",
|
|
22316
|
+
"maxLength": 20,
|
|
21883
22317
|
"in": "body"
|
|
21884
22318
|
},
|
|
21885
22319
|
{
|
|
@@ -22084,8 +22518,10 @@
|
|
|
22084
22518
|
"name": "client_ref_id",
|
|
22085
22519
|
"type": "string",
|
|
22086
22520
|
"required": false,
|
|
22087
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22521
|
+
"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
22522
|
"example": "2026010100123456789",
|
|
22523
|
+
"format": "client-ref",
|
|
22524
|
+
"maxLength": 20,
|
|
22089
22525
|
"in": "body"
|
|
22090
22526
|
},
|
|
22091
22527
|
{
|
|
@@ -22377,8 +22813,10 @@
|
|
|
22377
22813
|
"name": "client_ref_id",
|
|
22378
22814
|
"type": "string",
|
|
22379
22815
|
"required": false,
|
|
22380
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
22816
|
+
"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
22817
|
"example": "2026010100123456789",
|
|
22818
|
+
"format": "client-ref",
|
|
22819
|
+
"maxLength": 20,
|
|
22382
22820
|
"in": "body"
|
|
22383
22821
|
},
|
|
22384
22822
|
{
|
|
@@ -22619,8 +23057,10 @@
|
|
|
22619
23057
|
"name": "client_ref_id",
|
|
22620
23058
|
"type": "string",
|
|
22621
23059
|
"required": false,
|
|
22622
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
23060
|
+
"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
23061
|
"example": "2026010100123456789",
|
|
23062
|
+
"format": "client-ref",
|
|
23063
|
+
"maxLength": 20,
|
|
22624
23064
|
"in": "body"
|
|
22625
23065
|
},
|
|
22626
23066
|
{
|
|
@@ -22842,8 +23282,10 @@
|
|
|
22842
23282
|
"name": "client_ref_id",
|
|
22843
23283
|
"type": "string",
|
|
22844
23284
|
"required": false,
|
|
22845
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
23285
|
+
"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
23286
|
"example": "2026010100123456789",
|
|
23287
|
+
"format": "client-ref",
|
|
23288
|
+
"maxLength": 20,
|
|
22847
23289
|
"in": "body"
|
|
22848
23290
|
},
|
|
22849
23291
|
{
|
|
@@ -22859,6 +23301,7 @@
|
|
|
22859
23301
|
"name": "mobile",
|
|
22860
23302
|
"label": "Mobile Number",
|
|
22861
23303
|
"type": "string",
|
|
23304
|
+
"format": "mobile",
|
|
22862
23305
|
"required": true,
|
|
22863
23306
|
"description": "Customer's 10-digit primary mobile number to send the OTP to.",
|
|
22864
23307
|
"example": "9002336768",
|
|
@@ -23003,8 +23446,10 @@
|
|
|
23003
23446
|
"name": "client_ref_id",
|
|
23004
23447
|
"type": "string",
|
|
23005
23448
|
"required": false,
|
|
23006
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
23449
|
+
"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
23450
|
"example": "2026010100123456789",
|
|
23451
|
+
"format": "client-ref",
|
|
23452
|
+
"maxLength": 20,
|
|
23008
23453
|
"in": "body"
|
|
23009
23454
|
},
|
|
23010
23455
|
{
|
|
@@ -23020,6 +23465,7 @@
|
|
|
23020
23465
|
"name": "mobile",
|
|
23021
23466
|
"label": "Mobile Number",
|
|
23022
23467
|
"type": "string",
|
|
23468
|
+
"format": "mobile",
|
|
23023
23469
|
"required": true,
|
|
23024
23470
|
"description": "The same 10-digit mobile number the OTP was sent to.",
|
|
23025
23471
|
"example": "9002336768",
|
|
@@ -23185,8 +23631,10 @@
|
|
|
23185
23631
|
"name": "client_ref_id",
|
|
23186
23632
|
"type": "string",
|
|
23187
23633
|
"required": false,
|
|
23188
|
-
"description": "Unique reference ID per API call, generated by your system (max 20 characters).",
|
|
23634
|
+
"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
23635
|
"example": "2026010100123456789",
|
|
23636
|
+
"format": "client-ref",
|
|
23637
|
+
"maxLength": 20,
|
|
23190
23638
|
"in": "query"
|
|
23191
23639
|
},
|
|
23192
23640
|
{
|
|
@@ -23398,7 +23846,7 @@
|
|
|
23398
23846
|
"id": "aeps-fingpay-cash-withdrawal",
|
|
23399
23847
|
"slug": "aeps-fingpay-cash-withdrawal",
|
|
23400
23848
|
"name": "AePS (Fingpay) — Cash Withdrawal",
|
|
23401
|
-
"summary": "Aadhaar-enabled cash withdrawal: one-time agent activation and eKYC, daily KYC, then the biometric withdrawal.",
|
|
23849
|
+
"summary": "Aadhaar-enabled cash withdrawal: one-time agent activation and eKYC, daily KYC, a transaction OTP for amounts above ₹5,000, then the biometric withdrawal.",
|
|
23402
23850
|
"productId": "aeps",
|
|
23403
23851
|
"steps": [
|
|
23404
23852
|
{
|
|
@@ -23426,9 +23874,14 @@
|
|
|
23426
23874
|
"purpose": "Daily KYC — biometric-only, repeated once per calendar day before the agent's first transaction.",
|
|
23427
23875
|
"frequency": "daily"
|
|
23428
23876
|
},
|
|
23877
|
+
{
|
|
23878
|
+
"specSlug": "aeps-fingpay-cash-withdrawal-otp",
|
|
23879
|
+
"appliesWhen": "amount > ₹5,000",
|
|
23880
|
+
"purpose": "Generate the transaction OTP: the customer receives a 6-digit OTP by SMS on their Aadhaar-linked mobile, and the response returns `fp_transaction_id`. Generate a fresh one for every withdrawal attempt — it is never reusable."
|
|
23881
|
+
},
|
|
23429
23882
|
{
|
|
23430
23883
|
"specSlug": "aeps-fingpay-cash-withdrawal",
|
|
23431
|
-
"purpose": "Perform the biometric Aadhaar-enabled cash withdrawal.",
|
|
23884
|
+
"purpose": "Perform the biometric Aadhaar-enabled cash withdrawal. Above ₹5,000, send the `fp_transaction_id` as `txn_otp_request_id` AND put the customer's SMS OTP in the PidOptions `otp` attribute before the fingerprint capture — two different values, both required. A `response_type_id` of 1459 means the OTP step was skipped and nothing was withdrawn. Persist `tid`; on Pending (1465) reconcile via Transaction Inquiry before any retry.",
|
|
23432
23885
|
"branches": [
|
|
23433
23886
|
{
|
|
23434
23887
|
"onStatus": 0,
|
|
@@ -23605,6 +24058,27 @@
|
|
|
23605
24058
|
"type": "typeof fetch",
|
|
23606
24059
|
"required": false,
|
|
23607
24060
|
"description": "Inject a custom fetch implementation (proxies, tests)."
|
|
24061
|
+
},
|
|
24062
|
+
{
|
|
24063
|
+
"name": "retries",
|
|
24064
|
+
"type": "number",
|
|
24065
|
+
"required": false,
|
|
24066
|
+
"units": "default 2",
|
|
24067
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24068
|
+
},
|
|
24069
|
+
{
|
|
24070
|
+
"name": "retryBaseDelayMs",
|
|
24071
|
+
"type": "number",
|
|
24072
|
+
"required": false,
|
|
24073
|
+
"units": "milliseconds, default 200",
|
|
24074
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24075
|
+
},
|
|
24076
|
+
{
|
|
24077
|
+
"name": "autoStatusCheck",
|
|
24078
|
+
"type": "boolean",
|
|
24079
|
+
"required": false,
|
|
24080
|
+
"units": "default true",
|
|
24081
|
+
"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."
|
|
23608
24082
|
}
|
|
23609
24083
|
],
|
|
23610
24084
|
"members": [
|
|
@@ -23643,9 +24117,20 @@
|
|
|
23643
24117
|
"name": "SdkEndpoint / SdkParam",
|
|
23644
24118
|
"signature": "interface SdkEndpoint, interface SdkParam",
|
|
23645
24119
|
"description": "Shape of one endpoint in the embedded surface (slug, method, path, params)."
|
|
24120
|
+
},
|
|
24121
|
+
{
|
|
24122
|
+
"kind": "function",
|
|
24123
|
+
"name": "generateClientRefId",
|
|
24124
|
+
"signature": "generateClientRefId(nowMs: number): string",
|
|
24125
|
+
"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."
|
|
23646
24126
|
}
|
|
23647
24127
|
],
|
|
23648
24128
|
"errorTypes": [
|
|
24129
|
+
{
|
|
24130
|
+
"name": "EpsIndeterminateError",
|
|
24131
|
+
"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.",
|
|
24132
|
+
"fields": "`slug`, `clientRefId`, `status` (or null), `statusCheck` (inquiry envelope or null), `statusCheckError`, `cause`"
|
|
24133
|
+
},
|
|
23649
24134
|
{
|
|
23650
24135
|
"name": "EpsHttpError",
|
|
23651
24136
|
"when": "Any non-2xx response.",
|
|
@@ -23720,6 +24205,27 @@
|
|
|
23720
24205
|
"required": false,
|
|
23721
24206
|
"units": "seconds, default 30.0",
|
|
23722
24207
|
"description": "Whole-request budget passed through to `urlopen`."
|
|
24208
|
+
},
|
|
24209
|
+
{
|
|
24210
|
+
"name": "retries",
|
|
24211
|
+
"type": "int",
|
|
24212
|
+
"required": false,
|
|
24213
|
+
"units": "default 2",
|
|
24214
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24215
|
+
},
|
|
24216
|
+
{
|
|
24217
|
+
"name": "retry_base_delay",
|
|
24218
|
+
"type": "float",
|
|
24219
|
+
"required": false,
|
|
24220
|
+
"units": "seconds, default 0.2",
|
|
24221
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24222
|
+
},
|
|
24223
|
+
{
|
|
24224
|
+
"name": "auto_status_check",
|
|
24225
|
+
"type": "bool",
|
|
24226
|
+
"required": false,
|
|
24227
|
+
"units": "default true",
|
|
24228
|
+
"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."
|
|
23723
24229
|
}
|
|
23724
24230
|
],
|
|
23725
24231
|
"members": [
|
|
@@ -23764,9 +24270,20 @@
|
|
|
23764
24270
|
"name": "Target",
|
|
23765
24271
|
"signature": "@dataclass Target(method, url, body, headers, multipart)",
|
|
23766
24272
|
"description": "What `resolve_target` returns."
|
|
24273
|
+
},
|
|
24274
|
+
{
|
|
24275
|
+
"kind": "function",
|
|
24276
|
+
"name": "generate_client_ref_id",
|
|
24277
|
+
"signature": "generate_client_ref_id(now_ms: int) -> str",
|
|
24278
|
+
"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."
|
|
23767
24279
|
}
|
|
23768
24280
|
],
|
|
23769
24281
|
"errorTypes": [
|
|
24282
|
+
{
|
|
24283
|
+
"name": "EpsIndeterminateError",
|
|
24284
|
+
"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.",
|
|
24285
|
+
"fields": "`slug`, `client_ref_id`, `status` (or None), `status_check`, `status_check_error`, `__cause__`"
|
|
24286
|
+
},
|
|
23770
24287
|
{
|
|
23771
24288
|
"name": "EpsHttpError",
|
|
23772
24289
|
"when": "Any non-2xx response.",
|
|
@@ -23843,6 +24360,27 @@
|
|
|
23843
24360
|
"required": false,
|
|
23844
24361
|
"units": "seconds, default 30.0",
|
|
23845
24362
|
"description": "Whole-request budget, applied as `CURLOPT_TIMEOUT_MS` so sub-second values are not truncated."
|
|
24363
|
+
},
|
|
24364
|
+
{
|
|
24365
|
+
"name": "retries",
|
|
24366
|
+
"type": "int",
|
|
24367
|
+
"required": false,
|
|
24368
|
+
"units": "default 2",
|
|
24369
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24370
|
+
},
|
|
24371
|
+
{
|
|
24372
|
+
"name": "retryBaseDelay",
|
|
24373
|
+
"type": "float",
|
|
24374
|
+
"required": false,
|
|
24375
|
+
"units": "seconds, default 0.2",
|
|
24376
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24377
|
+
},
|
|
24378
|
+
{
|
|
24379
|
+
"name": "autoStatusCheck",
|
|
24380
|
+
"type": "bool",
|
|
24381
|
+
"required": false,
|
|
24382
|
+
"units": "default true",
|
|
24383
|
+
"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."
|
|
23846
24384
|
}
|
|
23847
24385
|
],
|
|
23848
24386
|
"members": [
|
|
@@ -23887,9 +24425,24 @@
|
|
|
23887
24425
|
"name": "EpsClient::MULTIPART_JSON_FIELD",
|
|
23888
24426
|
"signature": "const MULTIPART_JSON_FIELD = 'form-data'",
|
|
23889
24427
|
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
24428
|
+
},
|
|
24429
|
+
{
|
|
24430
|
+
"kind": "method",
|
|
24431
|
+
"name": "EpsClient::generateClientRefId",
|
|
24432
|
+
"signature": "EpsClient::generateClientRefId(int $nowMs): string",
|
|
24433
|
+
"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."
|
|
23890
24434
|
}
|
|
23891
24435
|
],
|
|
23892
24436
|
"errorTypes": [
|
|
24437
|
+
{
|
|
24438
|
+
"name": "Eko\\Eps\\EpsIndeterminateException",
|
|
24439
|
+
"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.",
|
|
24440
|
+
"fields": "`slug`, `clientRefId`, `status` (or null), `statusCheck`, `statusCheckError`, `getPrevious()`"
|
|
24441
|
+
},
|
|
24442
|
+
{
|
|
24443
|
+
"name": "Eko\\Eps\\EpsTransportException",
|
|
24444
|
+
"when": "The request produced no response at all (DNS, connect, TLS, timeout). Retried on GET; wraps the native error."
|
|
24445
|
+
},
|
|
23893
24446
|
{
|
|
23894
24447
|
"name": "Eko\\Eps\\EpsHttpException",
|
|
23895
24448
|
"when": "Any non-2xx response.",
|
|
@@ -23966,6 +24519,27 @@
|
|
|
23966
24519
|
"required": false,
|
|
23967
24520
|
"units": "default: 30s timeout",
|
|
23968
24521
|
"description": "Control timeouts, proxies or retries by supplying your own client."
|
|
24522
|
+
},
|
|
24523
|
+
{
|
|
24524
|
+
"name": "Retries",
|
|
24525
|
+
"type": "*int (nil → 2)",
|
|
24526
|
+
"required": false,
|
|
24527
|
+
"units": "default 2",
|
|
24528
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24529
|
+
},
|
|
24530
|
+
{
|
|
24531
|
+
"name": "RetryBaseDelay",
|
|
24532
|
+
"type": "time.Duration",
|
|
24533
|
+
"required": false,
|
|
24534
|
+
"units": "default 200ms",
|
|
24535
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24536
|
+
},
|
|
24537
|
+
{
|
|
24538
|
+
"name": "AutoStatusCheck",
|
|
24539
|
+
"type": "*bool (nil → true)",
|
|
24540
|
+
"required": false,
|
|
24541
|
+
"units": "default true",
|
|
24542
|
+
"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."
|
|
23969
24543
|
}
|
|
23970
24544
|
],
|
|
23971
24545
|
"members": [
|
|
@@ -24010,9 +24584,24 @@
|
|
|
24010
24584
|
"name": "eps.MultipartJSONField",
|
|
24011
24585
|
"signature": "MultipartJSONField = \"form-data\"",
|
|
24012
24586
|
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
24587
|
+
},
|
|
24588
|
+
{
|
|
24589
|
+
"kind": "function",
|
|
24590
|
+
"name": "GenerateClientRefID",
|
|
24591
|
+
"signature": "eps.GenerateClientRefID(nowMs int64) string",
|
|
24592
|
+
"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."
|
|
24013
24593
|
}
|
|
24014
24594
|
],
|
|
24015
24595
|
"errorTypes": [
|
|
24596
|
+
{
|
|
24597
|
+
"name": "*eps.IndeterminateError",
|
|
24598
|
+
"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.",
|
|
24599
|
+
"fields": "`Slug`, `ClientRefID`, `Status` (0 for transport), `StatusCheck`, `StatusCheckErr`, `Unwrap()`"
|
|
24600
|
+
},
|
|
24601
|
+
{
|
|
24602
|
+
"name": "*eps.TransportError",
|
|
24603
|
+
"when": "The request produced no response at all (DNS, connect, TLS, timeout). Retried on GET; wraps the native error."
|
|
24604
|
+
},
|
|
24016
24605
|
{
|
|
24017
24606
|
"name": "*eps.HTTPError",
|
|
24018
24607
|
"when": "Any non-2xx response. Match it with `errors.As`.",
|
|
@@ -24088,6 +24677,27 @@
|
|
|
24088
24677
|
"required": false,
|
|
24089
24678
|
"units": "default: 30s connect + 30s per request",
|
|
24090
24679
|
"description": "Control timeouts, proxies or redirects by supplying your own client."
|
|
24680
|
+
},
|
|
24681
|
+
{
|
|
24682
|
+
"name": ".retries(…)",
|
|
24683
|
+
"type": "int",
|
|
24684
|
+
"required": false,
|
|
24685
|
+
"units": "default 2",
|
|
24686
|
+
"description": "Extra attempts for a GET whose outcome was indeterminate (timeout, transport failure, HTTP 429/5xx). Non-GET calls are never retried. 0 disables."
|
|
24687
|
+
},
|
|
24688
|
+
{
|
|
24689
|
+
"name": ".retryBaseDelay(…)",
|
|
24690
|
+
"type": "Duration",
|
|
24691
|
+
"required": false,
|
|
24692
|
+
"units": "default 200ms",
|
|
24693
|
+
"description": "Backoff base: attempt n waits a random slice of min(base × 2^(n-1), 2s)."
|
|
24694
|
+
},
|
|
24695
|
+
{
|
|
24696
|
+
"name": ".autoStatusCheck(…)",
|
|
24697
|
+
"type": "boolean",
|
|
24698
|
+
"required": false,
|
|
24699
|
+
"units": "default true",
|
|
24700
|
+
"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."
|
|
24091
24701
|
}
|
|
24092
24702
|
],
|
|
24093
24703
|
"members": [
|
|
@@ -24132,9 +24742,24 @@
|
|
|
24132
24742
|
"name": "EpsClient.MULTIPART_JSON_FIELD",
|
|
24133
24743
|
"signature": "MULTIPART_JSON_FIELD = \"form-data\"",
|
|
24134
24744
|
"description": "Name of the single form field carrying the JSON envelope on file-upload endpoints."
|
|
24745
|
+
},
|
|
24746
|
+
{
|
|
24747
|
+
"kind": "method",
|
|
24748
|
+
"name": "EpsClient.generateClientRefId",
|
|
24749
|
+
"signature": "static String generateClientRefId(long nowMs)",
|
|
24750
|
+
"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."
|
|
24135
24751
|
}
|
|
24136
24752
|
],
|
|
24137
24753
|
"errorTypes": [
|
|
24754
|
+
{
|
|
24755
|
+
"name": "EpsClient.EpsIndeterminateException",
|
|
24756
|
+
"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.",
|
|
24757
|
+
"fields": "`slug`, `clientRefId`, `status` (or null), `statusCheck`, `statusCheckError`, `getCause()`"
|
|
24758
|
+
},
|
|
24759
|
+
{
|
|
24760
|
+
"name": "EpsClient.EpsTransportException",
|
|
24761
|
+
"when": "The request produced no response at all (DNS, connect, TLS, timeout). Retried on GET; wraps the native error."
|
|
24762
|
+
},
|
|
24138
24763
|
{
|
|
24139
24764
|
"name": "EpsClient.EpsHttpException",
|
|
24140
24765
|
"when": "Any non-2xx response.",
|