Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- ## List File Wire Instructions
- This endpoint retrieves wire instructions related to a File
- ### Endpoint
- `GET /ncs/v1/files/:id/wire-instructions`
- #### Path Parameters
- * **:id**: the ID of the File
- ### Authorization
- - Auth Token (Internal User)
- ### Responses
- #### 200 OK
- ```json
- {
- "wireInstructions": [
- {
- "id": 1,
- "organizationId": ":id",
- "accountHolderName": "Paul Kong",
- "lastUpdated": "2018-10-10 11:30:00",
- "lastStatusChangeDate": "2018-10-10 11:30:00",
- "status": "Created|Requested|Updated|AwaitingBankVerification|BankVerified|BankVerificationFailed",
- "fileId": ":id",
- "fileNumber": "string",
- "dealPartyName": "string",
- "dealPartyRole": "string",
- "dealPartyEmail": "string",
- "dealPartyMobile": "string",
- }
- ],
- "_meta": {
- "pagination": {
- "limit": 10,
- "page": 2,
- "total": 53,
- "pages": 5
- }
- }
- }
- ```
- #### 401 Unauthorized
- * Missing auth token
- * Auth token is invalid
- #### 403 Forbidden
- * Internal User does not have enough permissions (Disbursements)
- ------------------
- ## List Organization Wire Instructions
- This endpoint retrieves wire instructions with/without filters
- ### Endpoint
- `GET /ncs/v1/organizations/:id/wire-instructions`
- #### Path Parameters
- * **:id**: the ID of the Organization
- ### Authorization
- - Auth Token (Internal User)
- - Auth Token (External User)
- ### Responses
- #### 200 OK
- TBD: List unique wire instructions or one row per WI/File relationship
- #### 401 Unauthorized
- * Missing auth token
- * Auth token is invalid
- #### 403 Forbidden
- * External User Organization Id doesn't match request Organization Id
- * Internal User does not have enough permissions (Disbursements)
- ----------------------------
- ## List/Search Wire Instructions
- This endpoint retrieves wire instructions with/without filters
- ### Endpoint
- `GET /ncs/v1/wire-instructions`
- ### Query Parameters
- #### Search by File Number
- * **fileNumber**: string representing the File Number in FAST
- #### Search by Deal Party
- * **partyOrganizationId**: the Id of the party Organization
- * **partyName**: name of the file party
- ### Authorization
- - Auth token (Internal User)
- ### Responses
- #### 200 OK
- TBD: List unique wire instructions or one row per WI/File relationship
- #### 401 Unauthorized
- * Missing auth token
- * Auth token is invalid
- #### 403 Forbidden
- * Internal User does not have enough permissions (Disbursements)
Add Comment
Please, Sign In to add comment