API Specification Document

Lien API API Specification Document

Table of Contents

1. 2. This document needs to be completed by BSG & IT/Vendor for each Application /API.

Introduction Project – RBL API Banking 3. 4. List of API 5. 6. Sr. 7. Name 8. Description

9. 11. This API is used for Adding/Modifying/Inquiry 10. Lien API 1 Lien on RBL account

API Name a. Lien API 12. Description This API is used for Adding Lien on RBL account also used for Modifying Lien and to do Inquiry of Lien.

Transport protocol (SOAP / REST) REST 13. 14. API Request URLs 15. 16. https://apideveloper.rblbank.com/test/sb/v1/rbl/api/lien-api/marklien

17. 18. Access Requirement NA

Request Parameters for Adding Lien 22. Ta 24. P gs ar a 21. Par 23. M m 25. Para ame an et meter 20. Description ter da 26. Comments er Const Na to T raints me ry 19. Business y Paramet p er Name e 28. 32. Y 34. Alpha 29. numer 30. Transaction Id 33. St ic ri 35. MaxL 36. Transaction ID 31. Tra n ength generated by consumer 27. TranID nID g =16 which is unique 37. Corp_ID 38. 40. Cor 41. Y 42. St 43. Alpha 44. Unique ID assigned to 39. Corporate Id numer ic & ri MaxL p_I n ength D g =16 each enrolled Corporate 46. 49. Y 51. Alpha 47. Maker Id numer 50. St ic & 48. Ma ri MaxL 45. Maker_I ker_ n ength 52. Unique ID for request D ID g =20 creator 54. 57. Y 59. Alpha 55. Checker Id numer 58. St ic & 56. Che ri MaxL 53. Checker cker n ength 60. Unique ID for request _ID _ID g =20 checker 62. 65. Y 67. Alpha 63. Approver Id numer 64. App 66. St ic & rove ri 68. MaxL 61. Approve r_I n ength 69. Unique ID for request r_ID D g =20 approver 71. Lien Mode 73. Y 75. Alpha numer ic & 72. Lie 74. C MaxL 70. LienMo nM ha ength 76. Unique Lien Mode As de ode r =1 ‘A’ for Addition 78. Account 80. Y 81. N 82. Nume Number u ric & 79. Acc m MaxL 77. Account ount er ength 83. Customer Account No No ic =16 Number for Lien mark 85. Lien Amount 86. Lie 87. Y nA 88. Fl 84. LienAm mou oa 89. Nume 90. Lien Amount For Lien ount nt t ric Mark /Add 92. Start Date 93. Star 94. Y 95. D tdat at 96. Nume 97. Start Date For Lien 91. Startdate e e ric Add 99. End Date 100. En 101. Y 102. D dDa at 103. Num 104. End date For Lien 98. EndDate te e eric Add 106. Reason Code 108. Y 110. Alph anum 107. Re 109. S eric & aso tri MaxL 105. Reason nCo n ength 111. Reason Code for Lien Code de g =5 Add Request Sample for Adding Lien 112. { 113. "LienRequest": { 114. "Header": { 115. "TranID": "1478503665833", 116. "Corp_ID": "MC005", 117. "Maker_ID": "M001", 118. "Checker_ID": "C001", 119. "Approver_ID": "A001" 120. }, 121. "Body": { 122. "LienMode": "A", 123. "AccountNo": "405405405405", 124. "LienAmount": "91", 125. "Startdate": "2016-11-08", 126. "EndDate": "2017-11-12", 127. "ReasonCode": "99" 128. } 129. } 130. } 131. 132. Response Parameters for Add Lien 133. B us 137. P in ar 135. P 136. P es a ar ar s 134. D m a a P es et m m ar cr er et et a ip C 138. Comments er er m ti o N T et o ns a y er n tr m p N ai e e a nt m s e 139. T 140. 143. T 144. S 145. A 147. Transaction ID generated by consumer ra 141. ra tri lp which is unique nI 142. T nI n ha D ra D g n ns u ac m ti er o ic n 146. M Id ax L en gt h = 1 6 149. 153. Alpha 156. 157 150. Co numeri . rpor c & ate 152. S MaxLe 154. Unique ID assigned 148. Cor Id 151. Corp tri ngth=1 to each enrolled p_ID _ID ng 6 Corporate 159. 163. Alpha 166167 160. M numeri . . aker c & 158. Ma Id 162. S MaxLe ker_I 161. Mak tri ngth=2 164. Unique ID for D er_ID ng 0 request creator 169. 173. Alpha 176177 170. Ch numeri . . eck c & 168. Che er 171. Che 172. S MaxLe cker Id cker_ tri ngth=2 174. Unique ID for _ID ID ng 0 request checker 179. 183. Alpha 187188 180. Ap numeri . . 178. Ap pro c & prov ver 181. App 182. S 184. MaxL er_I Id rover tri ength= 185. Unique ID for D _ID ng 20 request approver 192. S 196197 189. Sta 190. St 191. Stat 194. SUCCESS/FAILUR tri 193. NA . . tus atus us E ng 202. N u m 199. A er cc 198. A 200. A ic o cc cc 201. N & u o o u M nt u u m ax N er L nt u nt ic en N m N gt o br o h e = 1 6 203. Customer Account Number for added Lien 204. L 205. L 206. L 207. F 208. N 209. Lien Amount ie ie ie lo u n n n at m A A A er m m m ic o o o u u u nt nt nt 214. A lp 210. L 211. L 212. L 213. S ha ie ie ie tri n 215. Lien Id for marked Lien nI n nI n u D Id D g m er ic 216. M es 217. M 218. M 219. S es es tri 220. N sa 221. Message for SUCCESS response sa sa n A g ge ge g e

Response Sample for Add Lien { "LienResponse": { "Header": { "TranID": "1478503665833", "Corp_ID": "MC005", "Maker_ID": "M001", "Checker_ID": "C001", "Approver_ID": "A001" }, "Body": { "Status": "SUCCESS", "AccountNo": " 405405405405 ", "LienAmount": "91", "LienID": "RB121482384", "Message": "Lien Successfully Added" } } } Request Parameters for Modifying Lien 225. T 227. P 222. Bu ag ar sine 224. Pa s a 223. De 228. Para ss ram m scri 226. M meter Par eter et 229. Comments ptio an Const ame Na er n da raints ter me to T Na ry y me pe 231. 234. Tr 235. Y 236. S 237. Alph 239. Transaction 230. Tra 232. anI tri anum ID generated nID 233. Tra D ng eric by consumer nsac 238. Max tion Lengt which is Id h=16 unique 241. 244. Y 246. Alph 242. Co anum rpor eric & 247. Unique ID 240. Co ate 243. Co 245. S MaxL assigned to rp_I Id rp_I tri ength each enrolled D D ng =16 Corporate 249. 252. Y 254. Alph 250. Ma anum ker eric & 248. Ma Id 251. M 253. S MaxL 255. Unique ID ker_ aker tri ength for request ID _ID ng =20 creator 257. 260. Y 262. Alph 258. Ch anum ecke 259. Ch eric & 256. Ch r Id eck 261. S MaxL 263. Unique ID ecke er_I tri ength for request r_ID D ng =20 checker 265. 268. Y 270. Alph 266. Ap anum 264. Ap prov 267. Ap eric & prov er Id pro 269. S 271. Max 272. Unique ID er_I ver_ tri Lengt for request D ID ng h=20 approver 274. Lie 276. Y 278. Alph n anum 279. Unique Mod 275. Li eric & Lien Mode 273. Lie e en 277. C MaxL As ‘M’ for nMo Mo ha ength Modifying de de r =1 Lien 281. Ac 283. Y cou 284. N 285. Num 280. Ac nt 282. Ac u eric & cou Nu cou m MaxL 286. Customer ntN mbe ntN er ength Account o r o ic =16 Number 287. Lie 288. Lie 289. Li 290. Y nA n enA 291. F 293. Lien mou Am mou lo 292. Num Amount For nt ount nt at eric Lien Modify 295. Lie 297. Y 298. S 299. Alph 300. Lien Id for 294. Lie n Id 296. Li tri anum Modifying nId enId ng eric Lien 301. Sta 302. Sta 303. Sta 304. Y 305. D 307. Start Date rtdat rt rtda at 306. Num For Lien e Date te e eric Modify 308. En 309. En 310. En 311. Y 312. D 314. End date dDa d dDa at 313. Num For Lien te Date te e eric Modify 316. Re 318. Y 320. Alph ason anum 315. Re Cod 317. Re eric & ason e aso 319. S MaxL 321. Reason Cod nCo tri ength Code for e de ng =5 Lien Modify

Request Sample for Modifying Lien 322. { 323. "LienRequest": { 324. "Header": { 325. "TranID": "1478506493428", 326. "Corp_ID": "MC003", 327. "Maker_ID": "M001", 328. "Checker_ID": "C001", 329. "Approver_ID": "A001" 330. }, 331. "Body": { 332. "LienMode": "M", 333. "AccountNo": "401234512345", 334. "LienAmount": "1", 335. "LienId": [ 336. "RB121482373" 337. ], 338. "Startdate": "2016-11-29", 339. "EndDate": "2017-11-04", 340. "ReasonCode": "9" 341. } 342. } 343. } 344. Response Parameters for Modifying lien 345. B us 349. P in ar 347. P 348. P es a ar ar s 346. D m a a P es et m m ar cr er et et a ip C 350. Comments er er m ti o N T et o ns a y er n tr m p N ai e e a nt m s e 351. T 352. 355. T 356. S 357. A 359. Transaction ID generated by consumer ra 353. ra tri lp which is unique nI 354. T nI n ha ra n ns u ac m ti er o ic n 358. M Id ax L en gt h = 1 D D g 6 361. 365. Alpha 368. 369 362. Co numeri . rpor c & ate 364. S MaxLe 366. Unique ID assigned 360. Cor Id 363. Corp tri ngth=1 to each enrolled p_ID _ID ng 6 Corporate 371. 375. Alpha 378379 372. M numeri . . aker c & 370. Ma Id 374. S MaxLe ker_I 373. Mak tri ngth=2 376. Unique ID for D er_ID ng 0 request creator 381. 385. Alpha 388389 382. Ch numeri . . eck c & 380. Che er 383. Che 384. S MaxLe cker Id cker_ tri ngth=2 386. Unique ID for _ID ID ng 0 request checker 391. 395. Alpha 399400 392. Ap numeri . . 390. Ap pro c & prov ver 393. App 394. S 396. MaxL er_I Id rover tri ength= 397. Unique ID for D _ID ng 20 request approver 404. S 408409 401. Sta 402. St 403. Stat 406. SUCCESS/FAILUR tri 405. NA . . tus atus us E ng 410. A 411. A 412. A 413. N 414. N 415. Customer Account Number cc cc cc u u o o o m m u u u er er nt nt nt ic ic N N N & u M o m o ax br L e en gt h = 1 6 416. L 417. L 418. L ie ie ie 420. N n n n 419. F u A A A lo m m m m at er o o o ic u u u nt nt nt 421. Lien Amount 426. A lp 422. L 423. L 424. L 425. S ha ie ie ie tri n 427. Modified Lien ID nI n nI n u D Id D g m er ic 428. M es 429. M 430. M 431. S es es tri 432. N sa 433. Message for SUCCESS response sa sa n A g ge ge g e Response Sample for Modifying Lien a. { b. "LienResponse": { c. "Header": { d. "TranID": "1478506493428", e. "Corp_ID": "MC003", f. "Maker_ID": "M001", g. "Checker_ID": "C001", h. "Approver_ID": "A001" i. }, j. "Body": { k. "Status": "SUCCESS", l. "AccountNo": "401234512345", m. "LienAmount": "1", n. "LienID": "RB121482373", o. "Message": "Lien Successfully Modified" p. } q. } r. } s. Request Parameters for Inquiry Lien 437. T 439. P 434. Bu ag ar sine 436. Pa s a 440. Para ss 435. Des ram m 438. M meter Par cripti eter et 441. Comments an Const ame on Na er da raints ter me to T Na ry y me pe 443. 447. Y 449. Alph 444. anum 445. Tran eric sactio 446. Tr 448. S 450. Max 451. Transaction ID 442. Tra n Id anI tri Lengt generated by consumer nID D ng h=16 which is unique 453. 456. Y 458. Alph 454. Cor anum porat eric & 452. Cor e Id 455. Co 457. S MaxL 459. Unique ID assigned p_I rp_I tri ength to each enrolled D D ng =16 Corporate 460. Ma 461. 463. M 464. Y 465. S 466. Alph 467. Unique ID for request 462. Mak anum er Id eric & MaxL ker_ aker tri ength ID _ID ng =20 creator 469. 472. Y 474. Alph 470. Che anum cker 471. Ch eric & 468. Ch Id eck 473. S MaxL ecke er_I tri ength 475. Unique ID for request r_ID D ng =20 checker 477. 480. Y 482. Alph 478. App anum 476. Ap rover 479. Ap eric & prov Id pro 481. S 483. Max er_I ver_ tri Lengt 484. Unique ID for request D ID ng h=20 approver 486. Lien 488. Y 490. Alph Mode anum 487. Li eric & 485. Lie en 489. C MaxL nMo Mo ha ength 491. Unique Lien Mode de de r =1 As ‘I’ for Addition 493. Acc 495. Y 496. N 497. Num ount 494. Ac u eric & 492. Ac Num cou m MaxL coun ber ntN er ength 498. Customer Account tNo o ic =16 Number 500. Lien 502. Y 503. S 504. Alph 499. Lie Id 501. Li tri anum 505. Lien Id for Inquiry nId enId ng eric Lien Request Sample for Inquiry Lien a. { b. "LienRequest": { c. "Header": { d. "TranID": "", e. "Corp_ID": "MC005", f. "Maker_ID": "M001", g. "Checker_ID": "C001", h. "Approver_ID": "A001" i. }, j. "Body": { k. "LienMode": "I", l. "AccountNo": "401234512345", m. "LienId": ["RB121482373"] n. } o. } p. }

Response Parameters for Inquiry Lien 506. B us 510. P in ar 508. P 509. P es a ar ar s 507. D m a a P es et m m ar cr er et et a ip C 511. Comments er er m ti o N T et o ns a y er n tr m p N ai e e a nt m s e 513. 518. A 514. lp 515. T ha ra n 512. T ns 516. T 517. S u ra ac ra tri m nI ti nI n er 520. Transaction ID generated by consumer D o D g ic which is unique n 519. M Id ax L en gt h = 1 6 522. 526. Alpha 529. 530 523. Co numeri . rpor c & ate 525. S MaxLe 527. Unique ID assigned 521. Cor Id 524. Corp tri ngth=1 to each enrolled p_ID _ID ng 6 Corporate 532. 536. Alpha 539540 533. M numeri . . aker c & 531. Ma Id 535. S MaxLe ker_I 534. Mak tri ngth=2 537. Unique ID for D er_ID ng 0 request creator 542. 546. Alpha 549550 543. Ch numeri . . eck c & 541. Che er 544. Che 545. S MaxLe cker Id cker_ tri ngth=2 547. Unique ID for _ID ID ng 0 request checker 552. 556. Alpha 560561 553. Ap numeri . . 551. Ap pro c & prov ver 554. App 555. S 557. MaxL er_I Id rover tri ength= 558. Unique ID for D _ID ng 20 request approver 565. S 569570 562. Sta 563. St 564. Stat 567. SUCCESS/FAILUR tri 566. NA . . tus atus us E ng 575. N u m 572. A er cc 571. A 573. A ic o cc cc 574. N & u o o u M nt u u m ax N er L nt u nt ic en N m N gt o br o h e = 1 6 576. Customer Account Number 577. L 578. L 579. L 580. F 581. N 582. Lien Amount ie ie ie lo u n n n A A A m m m m at er o o o ic u u u nt nt nt 587. A lp 583. L 584. L 585. L 586. S ha ie ie ie tri n 588. Lien ID nI n nI n u D Id D g m er ic 590. S 589. S ta 591. S 593. N ta rt ta u rt D rt 592. D m da at da at er te e te e ic 594. Start Date Of Lien 595. E 596. E 597. E n n n 599. N d d d u D D D 598. D m at at at at er e e e e ic 600. End date of lien 602. R 605. A ea lp so ha n n C u o m de er ic & M 601. R 603. R ax ea ea L so so en n n 604. S gt C C tri h o o n = de de g 5 606. Reason Code Of Lien a. Response Sample for Inquiry Lien 607. { 608. "LienResponse": { 609. "Header": { 610. "TranID": "1478506927395", 611. "Corp_ID": "MC005", 612. "Maker_ID": "M001", 613. "Checker_ID": "C001", 614. "Approver_ID": "A001" 615. }, 616. "Body": { 617. "Status": "SUCCESS", 618. "AccountNo": "401234512345", 619. "LienDtls": [ 620. { 621. "LienAmount": "1.0", 622. "LienId": "RB121482373", 623. "From_date": "2016-11-06T00:00:00.000", 624. "Exp_Date": "2017-11-04T00:00:00.000", 625. "ReasonCode": "9" 626. } 627. ] 628. } 629. } 630. } Response Codes 632. Respo 631. Response Stage nse 633. Response Message Code 634. SUCCESS 635. NA 636. Lien Successfully Added 637. SUCCESS 638. NA 639. Lien Successfully Modified 640. SUCCESS 641. NA 642. NA 644. ERR_L 643. FAILURE S_002 645. Duplicate TranID 647. ERR_L 646. FAILURE S_003 648. Invalid CorpID 650. ERR_L 649. FAILURE S_004 651. Invalid Corporate Hierarchy 653. ERR_L 652. FAILURE S_007 654. Amount cannot be 0 for Lien Addition 656. ERR_L 655. FAILURE S_008 657. Enter Valid Start Date and End Date 659. ERR_L 658. FAILURE S_009 660. Enter Valid End Date for Modification of Lien 662. ERR_L 661. FAILURE S_010 663. Improper JSON Format 665. ERR_L 664. FAILURE S_011 666. Schema Validation Failure 668. ERR_L 667. FAILURE S_014 669. Technical Failure 671. ERR_L 670. FAILURE S_016 672. Invalid Lien Mode 674. ERR_L 673. FAILURE S_018 675. Reason Code is Mandatory for this Lien Mode 677. ERR_L 676. FAILURE S_019 678. Lien ID does not exist 680. ERR_L 681. Lien ID Should not be present for this Lien 679. FAILURE S_019 Mode 683. E415 684. The date must be later than or same as the 682. FAILURE 7 BOD date 686. E422 685. FAILURE 1 687. Account is Frozen 689. E799 690. The verification is pending for the newly added 688. FAILURE 8 record. 691. FAILURE 692. BSM 693. The Lien Reason Code 0 is invalid 694. FAILURE 695. 100 696. General Error 697. FAILURE 698. 162 699. The account does not exist. 700. FAILURE 701. 342 702. The account has been closed.