Guest User

Untitled

a guest
Nov 14th, 2018
137
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 2.40 KB | None | 0 0
  1. ## List File Wire Instructions
  2.  
  3. This endpoint retrieves wire instructions related to a File
  4.  
  5. ### Endpoint
  6.  
  7. `GET /ncs/v1/files/:id/wire-instructions`
  8.  
  9. #### Path Parameters
  10.  
  11. * **:id**: the ID of the File
  12.  
  13. ### Authorization
  14.  
  15. - Auth Token (Internal User)
  16.  
  17. ### Responses
  18.  
  19. #### 200 OK
  20. ```json
  21. {
  22. "wireInstructions": [
  23. {
  24. "id": 1,
  25. "organizationId": ":id",
  26. "accountHolderName": "Paul Kong",
  27. "lastUpdated": "2018-10-10 11:30:00",
  28. "lastStatusChangeDate": "2018-10-10 11:30:00",
  29. "status": "Created|Requested|Updated|AwaitingBankVerification|BankVerified|BankVerificationFailed",
  30. "fileId": ":id",
  31. "fileNumber": "string",
  32. "dealPartyName": "string",
  33. "dealPartyRole": "string",
  34. "dealPartyEmail": "string",
  35. "dealPartyMobile": "string",
  36. }
  37. ],
  38. "_meta": {
  39. "pagination": {
  40. "limit": 10,
  41. "page": 2,
  42. "total": 53,
  43. "pages": 5
  44. }
  45. }
  46. }
  47. ```
  48. #### 401 Unauthorized
  49.  
  50. * Missing auth token
  51. * Auth token is invalid
  52.  
  53. #### 403 Forbidden
  54.  
  55. * Internal User does not have enough permissions (Disbursements)
  56.  
  57. ------------------
  58.  
  59. ## List Organization Wire Instructions
  60.  
  61. This endpoint retrieves wire instructions with/without filters
  62.  
  63. ### Endpoint
  64.  
  65. `GET /ncs/v1/organizations/:id/wire-instructions`
  66.  
  67. #### Path Parameters
  68.  
  69. * **:id**: the ID of the Organization
  70.  
  71. ### Authorization
  72.  
  73. - Auth Token (Internal User)
  74. - Auth Token (External User)
  75.  
  76. ### Responses
  77.  
  78. #### 200 OK
  79.  
  80. TBD: List unique wire instructions or one row per WI/File relationship
  81.  
  82. #### 401 Unauthorized
  83.  
  84. * Missing auth token
  85. * Auth token is invalid
  86.  
  87. #### 403 Forbidden
  88.  
  89. * External User Organization Id doesn't match request Organization Id
  90. * Internal User does not have enough permissions (Disbursements)
  91.  
  92. ----------------------------
  93.  
  94. ## List/Search Wire Instructions
  95.  
  96. This endpoint retrieves wire instructions with/without filters
  97.  
  98. ### Endpoint
  99.  
  100. `GET /ncs/v1/wire-instructions`
  101.  
  102. ### Query Parameters
  103.  
  104. #### Search by File Number
  105.  
  106. * **fileNumber**: string representing the File Number in FAST
  107.  
  108. #### Search by Deal Party
  109.  
  110. * **partyOrganizationId**: the Id of the party Organization
  111. * **partyName**: name of the file party
  112.  
  113.  
  114. ### Authorization
  115.  
  116. - Auth token (Internal User)
  117.  
  118. ### Responses
  119.  
  120. #### 200 OK
  121.  
  122.  
  123. TBD: List unique wire instructions or one row per WI/File relationship
  124.  
  125. #### 401 Unauthorized
  126.  
  127. * Missing auth token
  128. * Auth token is invalid
  129.  
  130. #### 403 Forbidden
  131.  
  132. * Internal User does not have enough permissions (Disbursements)
Add Comment
Please, Sign In to add comment