openapi: 3.2.0 info: version: '1.0' title: Application Services Form Capture API summary: List of services for application form data entry, submission & tracking description: This API facilitates the end-to-end process of application management. contact: name: akhilesh url: https://spliceforms.com/ email: api@apibanking.com license: url: https://spliceforms.com/ name: Commercial servers: - url: https://api.stitch.spliceforms.com/capture tags: - name: form-capture description: API endpoints for filling the application form information and submit for processing paths: /v1/application-forms: post: tags: - form-capture summary: Initiate application form capture description: This endpoint initiates the form data entry for new application there by generating new application id. Subsequent API interactions to capture the application form sections should be done using the application id returned by this endpoint. operationId: initiateApplication requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationInitiationRequest' responses: '200': description: Returns the OTP challenge response content: application/json: schema: $ref: '#/components/schemas/ApplicationInitiationResponse' '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: 5lav6ugrt0cyp /v1/application-forms/{applicationId}/accounts: post: tags: - form-capture summary: Save Account Preferences description: It allows you to add or update the account details to an existing application identified by the provided applicationId. operationId: saveAccount parameters: - name: applicationId in: path description: The application id required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/FDAccountWithOptionalPayout' responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: gzltrz01rtgl2 /v1/application-forms/{applicationId}/accounts/{accountSerialNo}: get: tags: - form-capture summary: Fetch Account Preferences description: It allows you to fetch the existing account details against the provided applicationId. operationId: fetchAccount parameters: - name: applicationId in: path description: The application id required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc - name: accountSerialNo in: path description: The account serial number required: true schema: $ref: '#/components/schemas/AccountSerialNo' responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. content: application/json: schema: type: object properties: account: oneOf: - $ref: '#/components/schemas/FDAccountWithOptionalPayout' '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: s1qcizfbs6iki /v1/application-forms/{applicationId}/accounts/{accountSerialNo}/nomination: post: tags: - form-capture summary: Save Nomination description: It allows you to add a new nominee to the account being created as part of the application operationId: saveAccountNomination parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc - name: accountSerialNo in: path description: The account serial number required: true schema: $ref: '#/components/schemas/AccountSerialNo' requestBody: content: application/json: schema: $ref: '#/components/schemas/Nominee' responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: 9n5wb39ehyf27 get: tags: - form-capture summary: Fetch Nomination description: It allows you to fetch the existing nominee details against the provided applicationId. operationId: fetchAccountNomination parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc - name: accountSerialNo in: path description: The account serial number required: true schema: $ref: '#/components/schemas/AccountSerialNo' responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. content: application/json: schema: $ref: '#/components/schemas/Nominee' '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: tdymzwr7isjrn delete: tags: - form-capture summary: Delete Nomination description: It allows you to delete the existing nominee details for the account operationId: deleteAccountNomination parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc - name: accountSerialNo in: path description: The account serial number required: true schema: $ref: '#/components/schemas/AccountSerialNo' responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: iwbmr9lcwgdq6 /v1/application-forms/{applicationId}/payin-preferences: post: tags: - form-capture summary: Save Payin Preferences description: It allows you to save payin preferences for the application operationId: savePayinPreferences parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: content: application/json: schema: $ref: '#/components/schemas/PayinSourcePreference' responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: 9nohyjo4g7pml get: tags: - form-capture summary: Fetch Payin Preferences description: It allows you to fetch the existing payin preference details against the provided applicationId. operationId: fetchPayinPreferences parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. content: application/json: schema: $ref: '#/components/schemas/Payin' '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: 9s37wkgnopyrn delete: tags: - form-capture summary: Delete Payin Preferences description: It allows you to delete the existing payin preference details against the provided applicationId. operationId: deletePayinPreferences parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: mjy02dqmyih16 /v1/application-forms/{applicationId}/staff: post: tags: - form-capture summary: Save Staff description: It allows you to add staff details to an existing application identified by the provided applicationId. operationId: saveStaff parameters: - name: applicationId in: path description: The application id required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: content: application/json: schema: $ref: '#/components/schemas/Staff' responses: '200': description: 'This status code indicates that the request was received, understood, and processed successfully by the server. ' '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: 73mv8qm807e4n get: tags: - form-capture summary: Fetch Staff description: It allows you to fetch the existing staff details against the provided applicationId. operationId: fetchStaff parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. content: application/json: schema: $ref: '#/components/schemas/Staff' examples: Example 1: value: branchCode: '01102' lgCode: C098 lcCode: C098 '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: 7yqrhu9g8uf5q delete: tags: - form-capture summary: Delete Staff description: It allows you to delete the existing staff details against the provided applicationId. operationId: deleteStaff parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: m7meet32vv8cv /v1/application-forms/{applicationId}/consents: post: tags: - form-capture summary: Save Consents description: It allows you to add or update the consent details to an existing application identified by the provided applicationId. operationId: saveConsents parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: content: application/json: schema: type: object required: - consentIds properties: consentIds: type: array description: List of consent Ids from CMS, provided in application form. items: x-unresolved-stoplight-ref: stoplight://resources/overrides/o9idCqAmha8 responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. content: application/json: schema: type: object properties: referenceId: x-unresolved-stoplight-ref: stoplight://resources/overrides/JVJLO1LAh5U '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: 8jpe1o12y8kon get: tags: - form-capture summary: Fetch Consents description: It allows you to fetch the existing consent details against the provided applicationId. operationId: fetchConsents parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: content: {} responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. The response body will contain the data requested by the client. content: application/json: schema: type: object properties: consentIds: type: array description: List of consent ids which are accepted by the applicant items: x-unresolved-stoplight-ref: stoplight://resources/overrides/o9idCqAmha8 referenceId: x-unresolved-stoplight-ref: stoplight://resources/overrides/JVJLO1LAh5U '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: fwr8ey3ep0a9m /v1/application-forms/{applicationId}/payin: post: tags: - form-capture summary: Initiate Payin Request description: Initiates Payment based on the instrument mentioned in the request. operationId: initiatePayin parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: description: Shared Request content: application/json: schema: $ref: '#/components/schemas/PayinRequest' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PayinInitiationResponse' text/html: schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/TNriCWFEB1s '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: syec6hhrtjyxb /v1/application-forms/{applicationId}/payin/status: post: tags: - form-capture summary: Fetch Payin Status description: It retrieves the current status of the payment using the request reference number operationId: fetchPayinStatus parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/PaymentStatusRequest' responses: '200': description: Shared Response content: application/json: schema: $ref: '#/components/schemas/PayinStatusResponse' '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com voilations: - field: string in: string message: string '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: luc99g76ks5n0 /v1/application-forms/{applicationId}/validation: post: tags: - form-capture summary: Validate Application Form description: It performs all the validations to ensure that the information captured in the application form is complete. If the application is already saved as a draft as part of step-by-step capture APIs then it reads the application form payload associated with the application id. Otherwise application form payload needs to be sent in the request body. operationId: validateApplicationForm parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: content: application/json: schema: $ref: '#/components/schemas/ETBFDApplicationForm' responses: '200': description: This status code indicates that the request was received, understood, and processed successfully by the server. '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: q3ceu762vrkr4 /v1/application-forms/{applicationId}/submission: post: tags: - form-capture summary: Submit Application Form description: 'It validates and submits the application form for processing. If the application is already saved as a draft as part of step-by-step capture APIs then it reads the application form payload associated with the application id for submission. Otherwise application form payload needs to be sent in the request body. On successful acceptance of the application form, application is created in the system. Status API endpoint can be used to fetch the processing status of the application.' operationId: submitApplicationForm parameters: - name: applicationId in: path description: The application form Identifier. required: true schema: x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc requestBody: content: application/json: schema: $ref: '#/components/schemas/ETBFDApplicationForm' examples: {} responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/ETBFDApplicationStatus' '400': description: This status code indicates that the server could not understand or process the request due to invalid syntax or parameters. The client should modify the request and retry. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 400 detail: string instance: http://example.com validationErrors: - message: string properties: - string severity: ERROR '500': description: This status code means the server ran into an unexpected problem while processing your request. It indicates an issue on the server side, not with your input. Try refreshing or resubmitting your request after a short wait. content: application/json: schema: $ref: '#/components/schemas/ProblemJson' examples: Example 1: value: title: string status: 500 detail: string instance: http://example.com servers: - url: https://api.stitch.spliceforms.com/capture x-stoplight: id: qlosjv7cxj04b components: schemas: FDAccount: type: object title: FDAccount description: Represents the preferences for FD account x-stoplight: id: 8x0xxhz2zj4g7 required: - branchCode - amount - interestPayoutTreatment - maturityInstruction - tenure - payout properties: branchCode: description: The unique code representing the specific branch of the bank. The allowed values will have to comply with the values of "branchCode" codeset. x-unresolved-stoplight-ref: stoplight://resources/overrides/DkpDaBt77Zw amount: x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY interestPayoutTreatment: x-unresolved-stoplight-ref: stoplight://resources/overrides/GIH20YnXrJk maturityInstruction: x-unresolved-stoplight-ref: stoplight://resources/overrides/hNcvI153XgU tenure: $ref: '#/components/schemas/FDTenure' payout: $ref: '#/components/schemas/FDPayout' accountSerialNo: $ref: '#/components/schemas/AccountSerialNo' ETBIndividualApplicant: type: object title: ETBIndividualApplicant description: It includes essential information of an individual x-stoplight: id: nub97d2z8vpme required: - mobileNo - dob properties: mobileNo: x-unresolved-stoplight-ref: stoplight://resources/overrides/LT9qrA1aRC4 dob: x-unresolved-stoplight-ref: stoplight://resources/overrides/UEKAfGKnXtA PayinInitiationResponse: type: object title: PayinInitiationResponse description: Response for the payin request x-stoplight: id: wfu74s8hlrtni required: - orderId - transactionId properties: link: $ref: '#/components/schemas/PaymentLink' orderId: x-unresolved-stoplight-ref: stoplight://resources/overrides/DKNg0X01iqs transactionId: x-unresolved-stoplight-ref: stoplight://resources/overrides/ixcWjoDYuA0 FDApplication: title: FDApplication description: Contains the common fields for FD applications x-stoplight: id: 03tu6sm7n4z9f allOf: - x-stoplight: id: wnurm5fra1b03 $ref: '#/components/schemas/Application' - type: object required: - declaration - payin properties: declaration: $ref: '#/components/schemas/Declaration' payin: $ref: '#/components/schemas/Payin' examples: - {} ExternalFundingPreference: type: object title: ExternalFundingPreference description: Funds sourced from an external bank account. x-stoplight: id: o3q2qk9qvxa1k required: - amount - account properties: amount: x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY account: $ref: '#/components/schemas/ExternalBankAccount' ExternalFunding: type: object title: ExternalFunding description: Funds sourced from an external bank account. x-stoplight: id: ao20fp8fvlkg8 required: - amount - method - instrument properties: amount: x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY method: description: Possible methods for getting funds from external accounts $ref: '#/components/schemas/ExternalFundingMethodType' instrument: oneOf: - $ref: '#/components/schemas/Upi' - $ref: '#/components/schemas/Netbanking' PayinStatusResponse: type: object title: PayinStatusResponse x-stoplight: id: p5cr7qcqolbas required: - status properties: status: x-unresolved-stoplight-ref: stoplight://resources/overrides/4jnPFrrRuI0 ETBFDApplicationForm: type: object title: ETBFDApplicationForm description: Represents the application form to open FD account for ETB customers x-stoplight: id: l8m92a0jzcm0e required: - application - applicant - account properties: application: $ref: '#/components/schemas/FDApplication' applicant: $ref: '#/components/schemas/ETBIndividualApplicant' account: $ref: '#/components/schemas/FDAccount' examples: - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} - {} PayinSourcePreference: type: object title: PayinSourcePreference description: 'Payment source preference for the application ' properties: sourceType: $ref: '#/components/schemas/PayinSourceType' source: oneOf: - $ref: '#/components/schemas/InternalFundingPreference' - $ref: '#/components/schemas/ExternalFundingPreference' - $ref: '#/components/schemas/CombinedFundingPreference' required: - sourceType - source x-stoplight: id: okkw9jkejlgpl ETBFDApplicationStatus: type: object title: ETBFDApplicationStatus description: Processing status for ETB FD application x-stoplight: id: tmhi5v9yp9q61 required: - status properties: status: x-unresolved-stoplight-ref: stoplight://resources/overrides/9mKfsqolpW4 accountOpeningResult: $ref: '#/components/schemas/AccountOpeningResult' ApplicationInitiationResponse: title: ApplicationInitiationResponse x-stoplight: id: 37v0sgxkmy0da type: object required: - applicationId properties: applicationId: x-stoplight: id: 7gk5382vwbmwd x-unresolved-stoplight-ref: stoplight://resources/overrides/NPaBdSGrXxc Guardian: type: object title: Guardian description: It refers to the information related to the person who will act as a legal guardian for the nominee in case the nominee is a minor or unable to manage their own affairs. x-stoplight: id: lghrra139m815 required: - name - dob - address properties: name: description: Full name of the guardian x-unresolved-stoplight-ref: stoplight://resources/overrides/5yNhk1Hgfig dob: description: The exact date on which the guardian was born, including the day, month, and year. x-unresolved-stoplight-ref: stoplight://resources/overrides/UEKAfGKnXtA relationshipWithNominee: description: Specifies the nature of the connection between two parties. The allowed values will have to comply with the values of "nomineeRelationCode" codeset. x-unresolved-stoplight-ref: stoplight://resources/overrides/rCj13ihpGbg address: $ref: '#/components/schemas/GuardianAddress' Payin: type: object title: Payin description: Contains the funding details, including the amount and payment method. properties: sourceType: $ref: '#/components/schemas/PayinSourceType' source: oneOf: - $ref: '#/components/schemas/InternalFunding' - $ref: '#/components/schemas/ExternalFunding' - $ref: '#/components/schemas/CombinedFunding' required: - sourceType - source x-stoplight: id: t1x11o2a16hbi FDAccountOpeningResult: type: object title: FDAccountOpeningResult x-stoplight: id: p30gaesnmzwua required: - accountSerialNo - accountNo properties: accountSerialNo: $ref: '#/components/schemas/AccountSerialNo' accountNo: x-unresolved-stoplight-ref: stoplight://resources/overrides/NTK9s0hcXsQ accountType: x-unresolved-stoplight-ref: stoplight://resources/overrides/tCwO6x9ZNk0 NomineeAddress: type: object title: NomineeAddress description: Specifies the complete address details of the nominee. x-package: nomination x-stoplight: id: u5dcf6yibq6yq required: - line - cityCode - stateCode - countryCode - pinCode properties: line: x-unresolved-stoplight-ref: stoplight://resources/overrides/cJk4qn60FYo cityCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/e716yeYODOc stateCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/Cvh9dy4b2Bc countryCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/TefCsIHCKhs pinCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/Ov8lL8w72Jo FDAccountWithOptionalPayout: type: object title: FDAccountWithOptionalPayout description: 'Represents the preferences for FD account. Optionally payout preferences also can be provided ' x-stoplight: id: kmnqbs2c1nykz required: - branchCode - amount - interestPayoutTreatment - maturityInstruction - tenure properties: branchCode: description: The unique code representing the specific branch of the bank. The allowed values will have to comply with the values of "branchCode" codeset. x-unresolved-stoplight-ref: stoplight://resources/overrides/DkpDaBt77Zw amount: x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY interestPayoutTreatment: x-unresolved-stoplight-ref: stoplight://resources/overrides/GIH20YnXrJk maturityInstruction: x-unresolved-stoplight-ref: stoplight://resources/overrides/hNcvI153XgU tenure: $ref: '#/components/schemas/FDTenure' payout: $ref: '#/components/schemas/FDPayout' accountSerialNo: $ref: '#/components/schemas/AccountSerialNo' ExternalFundingMethodType: description: Options through which applicant can make a deposit using external bank accounts title: ExternalFundingMethodType type: string x-stoplight: id: juqy97cplinyp enum: - UPI - NETBANKING pattern: ^[A-Z_]+ minLength: 3 maxLength: 10 examples: - UPI ExternalFundingRequest: type: object title: ExternalFundingRequest description: Funds sourced from an external bank account. x-stoplight: id: eyiccvugl6ed6 required: - method - instrument properties: method: description: Possible methods for getting funds from external accounts $ref: '#/components/schemas/ExternalFundingMethodType' instrument: oneOf: - $ref: '#/components/schemas/UpiPaymentRequest' - $ref: '#/components/schemas/NetbankingPaymentRequest' ProblemJson: type: object x-stoplight: id: oooamay5pgk0b title: ProblemJson description: Problem Error Json required: - title - status properties: title: type: string description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). pattern: ^[A-Za-z0-9-_]+ minLength: 2 maxLength: 50 examples: - Unauthorized x-stoplight: id: qp048dxgamcyv status: type: integer description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. format: int32 minimum: 1 maximum: 1000 examples: - 200 x-stoplight: id: mppplj2ikgpo5 detail: type: string description: A human-readable explanation specific to this occurrence of the problem. pattern: ^[A-Za-z0-9-_ ]+ minLength: 5 maxLength: 2043 examples: - api_key missing x-stoplight: id: 05ie4179zj1s5 instance: type: string description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. format: uri pattern: ^(https?|http):\/\/[^\s/$.?#].[^\s]*$ minLength: 5 maxLength: 2083 examples: - https://example.com/resource x-stoplight: id: f0d9smdiysl1b validationErrors: type: array description: Validation Errors items: x-stoplight: id: 7vcjnrvdy7wos $ref: '#/components/schemas/ValidationError' x-stoplight: id: uxclbrhmspafm CombinedFundingPreference: title: CombinedFundingPreference description: Funds are sourced from both internal and external accounts. allOf: - $ref: '#/components/schemas/InternalFundingPreference' - $ref: '#/components/schemas/ExternalFundingPreference' x-stoplight: id: v0x3zc4toa407 InternalFundingPreference: type: object title: InternalFundingPreference description: Funds drawn from an account within the bank. x-stoplight: id: gx4gqeyebnbjy required: - amount - account properties: amount: x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY account: $ref: '#/components/schemas/InternalBankAccount' Declaration: type: object title: Declaration description: A declaration may include consent for compliance, acknowledgment of policies, and confirmation of provided details. x-stoplight: id: r34kag2o5sm70 required: - isNominationOpted - da1Nomination - consentReferenceId properties: isNominationOpted: type: boolean description: This indicates whether the account holder chooses to nominate a beneficiary who will receive the funds in the account in the event of the account holder’s demise. If boolean is true then details in "nominationForDa1" has to be filled da1Nomination: $ref: '#/components/schemas/Nominee' consentReferenceId: x-unresolved-stoplight-ref: stoplight://resources/overrides/JVJLO1LAh5U PayinSourceType: type: string enum: - INTERNAL - EXTERNAL - COMBINED title: PayinSourceType description: Indicates the type of source for the payin pattern: ^[A-Z_]+ minLength: 8 maxLength: 8 examples: - INTERNAL x-stoplight: id: 5nyt7q7ez37fc CombinedFunding: title: CombinedFunding description: Funds are sourced from both internal and external accounts. x-stoplight: id: nztq8dlqfxcxw type: object required: - internal - external properties: internal: $ref: '#/components/schemas/InternalFunding' x-stoplight: id: e4woy7sko96a8 external: $ref: '#/components/schemas/ExternalFunding' x-stoplight: id: e2pzhjp9emz40 UpiPaymentRequest: type: object title: UpiPaymentRequest description: Contains details of the UPI payment request x-stoplight: id: ar2fr8aiikut5 required: - vpa - account properties: vpa: x-unresolved-stoplight-ref: stoplight://resources/overrides/ruVStTpk5p0 account: $ref: '#/components/schemas/ExternalBankAccount' FDTenure: type: object title: FDTenure description: This indicates the duration for which the Fixed Deposit (FD) is held, expressed in days, months and years. x-stoplight: id: b8a8yencrf6fn required: - days - months - years properties: days: type: integer description: Tenure expressed in days format: int32 minimum: 1 maximum: 31 example: 1 months: type: integer description: Tenure expressed in months format: int32 minimum: 6 maximum: 11 examples: - 6 years: type: integer description: Tenure expressed in years format: int32 minimum: 0 maximum: 10 examples: - 1 PaymentLink: type: object title: PaymentLink description: Payment Link information x-stoplight: id: wapt3fttiu0dd required: - httpMethod - url properties: httpMethod: x-unresolved-stoplight-ref: stoplight://resources/overrides/LxfGWMR4qzg url: x-unresolved-stoplight-ref: stoplight://resources/overrides/YjqooP8HUgE params: type: object description: Indicates the list of parameters to be posted along with the payment URL additionalProperties: type: object description: Indicates the value of the parameter PaymentStatusRequest: type: object title: PaymentStatusRequest x-stoplight: id: 6ighht0beprif required: - requestReferenceNo properties: requestReferenceNo: x-unresolved-stoplight-ref: stoplight://resources/overrides/LxUYQPKCXxM ApplicationInitiationRequest: title: ApplicationInitiationRequest x-stoplight: id: lomcyj5xgtc2l type: object required: - applicant properties: applicant: $ref: '#/components/schemas/ETBIndividualApplicant' x-stoplight: id: vdrn4pc3oibcx staff: x-stoplight: id: sgof4h8njxbtf $ref: '#/components/schemas/Staff' Netbanking: type: object title: Netbanking description: Contains details of the netbanking instrument. x-stoplight: id: l5n40oebtpux4 required: - account - paymentReferenceNo properties: account: $ref: '#/components/schemas/ExternalBankAccount' paymentReferenceNo: x-unresolved-stoplight-ref: stoplight://resources/overrides/dzVlqIouteM GuardianAddress: type: object title: GuardianAddress description: Specifies the complete address details of the guardian. x-package: nomination x-stoplight: id: v86vldk7j4odh required: - line - cityCode - stateCode - countryCode - pinCode properties: line: x-unresolved-stoplight-ref: stoplight://resources/overrides/cJk4qn60FYo cityCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/e716yeYODOc stateCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/Cvh9dy4b2Bc countryCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/TefCsIHCKhs pinCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/Ov8lL8w72Jo Upi: type: object title: Upi description: Contains details of the UPI instrument. x-stoplight: id: fwcfjb6bphkmw required: - vpa - account - paymentReferenceNo properties: vpa: x-unresolved-stoplight-ref: stoplight://resources/overrides/ruVStTpk5p0 account: $ref: '#/components/schemas/ExternalBankAccount' paymentReferenceNo: x-stoplight: {} x-unresolved-stoplight-ref: stoplight://resources/overrides/dzVlqIouteM Nominee: type: object title: Nominee description: Specifies the personal information of the nominee designated by the account holder. x-package: nomination x-stoplight: id: 70bneppghra7k required: - name - dob - address - relationshipWithApplicant properties: name: description: The full name of the individual nominated by the account holder to receive the benefits or proceeds of the account in the event of the account holder's demise. x-unresolved-stoplight-ref: stoplight://resources/overrides/5yNhk1Hgfig dob: description: 'If nominee dob is less than 18yrs then guardian details in "guardian" has to be filled. ' x-unresolved-stoplight-ref: stoplight://resources/overrides/UEKAfGKnXtA address: $ref: '#/components/schemas/NomineeAddress' relationshipWithApplicant: description: 'Relationship of Nominee with Applicant/Depositor. The allowed values will have to comply with the values of codeset' x-unresolved-stoplight-ref: stoplight://resources/overrides/02QZBj0cg1s guardian: $ref: '#/components/schemas/Guardian' sharePercentage: x-stoplight: id: z2a474uhtz3pr x-unresolved-stoplight-ref: stoplight://resources/overrides/IVykiNdyptI AccountSerialNo: type: integer title: AccountSerialNo description: Indicates the serial number of the account which is added to the application format: int32 minimum: 1 maximum: 1 examples: - 1 x-stoplight: id: myofrfpy3wo2a InternalBankAccount: type: object title: InternalBankAccount description: Specifies the internal bank account details examples: - accountNo: '002001053410' x-stoplight: id: cqj717kedsbpl required: - accountNo properties: accountNo: x-unresolved-stoplight-ref: stoplight://resources/overrides/swJoliwLU7s PayinRequest: type: object title: PayinRequest description: Payin request x-stoplight: id: odvdz2ke622gr required: - requestReferenceNo - amount - source - device properties: requestReferenceNo: x-unresolved-stoplight-ref: stoplight://resources/overrides/LxUYQPKCXxM amount: x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY source: $ref: '#/components/schemas/ExternalFundingRequest' device: $ref: '#/components/schemas/Device' AccountOpeningResult: type: object title: AccountOpeningResult description: Account opening result properties: accounts: type: array description: List of accounts opened as part of application processing items: oneOf: - $ref: '#/components/schemas/FDAccountOpeningResult' required: - accounts x-stoplight: id: 5c1hf4pjkjkjw ExternalBankAccount: type: object title: ExternalBankAccount description: Contains details of the NEFT instrument. x-package: payment.instrument x-stoplight: id: jp29joi2rdyw4 required: - accountType - accountNo - ifsc properties: accountType: x-unresolved-stoplight-ref: stoplight://resources/overrides/tCwO6x9ZNk0 accountNo: x-unresolved-stoplight-ref: stoplight://resources/overrides/swJoliwLU7s ifsc: x-unresolved-stoplight-ref: stoplight://resources/overrides/5js4tqEmILQ InternalFunding: type: object title: InternalFunding description: Funds drawn from an account within the bank. x-stoplight: id: ryga2hh0o90se required: - amount - instrument properties: amount: x-unresolved-stoplight-ref: stoplight://resources/overrides/wbgPBBXK2qY instrument: $ref: '#/components/schemas/InternalBankAccount' Application: title: Application x-stoplight: id: zzae6t0s9xwav type: object description: Common/base model for application with common attributes. Concrete models for specific channel application forms should extend this (using allOff construct) properties: staff: x-stoplight: id: 9ntisl8skcjuj $ref: '#/components/schemas/Staff' NetbankingPaymentRequest: type: object title: NetbankingPaymentRequest description: Contains details of the netbanking payment request. properties: account: $ref: '#/components/schemas/ExternalBankAccount' required: - account x-stoplight: id: opeyfm5n1c05u FDPayout: type: object title: FDPayout description: Specifies the methods to payout FD interest and/or principal on maturity x-package: account.fd x-stoplight: id: zi0w6z8evo404 required: - mode - instrument properties: mode: x-unresolved-stoplight-ref: stoplight://resources/overrides/1Ll91UtXZ2s instrument: oneOf: - $ref: '#/components/schemas/InternalBankAccount' - $ref: '#/components/schemas/ExternalBankAccount' ValidationError: type: object x-stoplight: id: i03w36ken44hv title: ValidationError description: Validation Error required: - message - severity properties: message: type: string description: Message for the validation error pattern: ^[A-Za-z0-9-_ ]+ minLength: 2 maxLength: 2048 examples: - fields can not be empty x-stoplight: id: vfc11e0vv4ka0 fields: type: array description: One or more properties on which the validation was performed. items: type: string description: Propertie on which the validation was performed. pattern: ^[A-Za-z0-9-_]+ minLength: 2 maxLength: 50 examples: - '23212322' x-stoplight: id: 7ezn2bw6cptug x-stoplight: id: ngstgikrr1jga severity: type: string enum: - ERROR - WARNING description: Severity of the validation error. pattern: ^[A-Z]+(_[A-Z]+)*$ minLength: 2 maxLength: 50 examples: - ERROR x-stoplight: id: kcvbyilxmlci5 Staff: type: object title: Staff description: It captures key details of a bank staff involved in processing an application x-stoplight: id: 36aobxkwelk2l required: - branchCode - lgCode - lcCode properties: branchCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/DkpDaBt77Zw lgCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/gHuU3wTRjT0 lcCode: x-unresolved-stoplight-ref: stoplight://resources/overrides/pZLZAOMcf2s Device: type: object title: Device description: It captures details about the device initiating the request properties: channelId: type: string description: The unique code representing the specific channel. pattern: ^\d{1,5}$ minLength: 1 maxLength: 5 examples: - '10907' ipAddress: type: string description: The IP address of the device. format: ipv6 pattern: ^([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9])?[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9])?[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9])?[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9])?[0-9])$ minLength: 2 maxLength: 39 examples: - 2001:0db8:85a3:0000:0000:8a2e:0370:7334 userAgent: type: string description: The user agent of the device. pattern: ^[A-Za-z ]+ minLength: 1 maxLength: 100 examples: - Chrome required: - channelId - userAgent x-stoplight: id: 01tld0hvzfmpg x-stoplight: id: yewzi8y7jhaeg x-internal: true x-source: https://github.com/spliceforms/stoplight-projects/blob/main/stitch-capture-services/capture-services-v1.0.yaml x-bundled-from: openapi/_original/stitch-capture-services/capture-services-v1.0.yaml (./models refs inlined into components/schemas; stoplight:// platform overrides are not resolvable outside Stoplight and are kept as x-unresolved-stoplight-ref)