The Direct Deposit API is designed to facilitate seamless connection between a user's financial accounts and the banking application. It enables users to directly deposit funds into their Netevia banking account, including salary deposits without the need for additional paperwork. This API plays a crucial role in establishing and managing these connections through secure, time-limited tokens.
This API endpoint retrieves a token for linking a financial account in the Direct Deposit system. The token is essential for initiating the connection flow between the banking application and Direct Deposit.
Request Parameters:
- FinancialAccountId: The unique identifier for the financial account for which the link token is being requested.
Response Structure:
On a successful request, the API returns a response containing the following fields:
- timeStamp: The time at which the request was processed, formatted in ISO 8601.
- success: A boolean value indicating whether the operation was successful (true or false).
- error: If there is an error, this field will contain error details; otherwise, it will be null.
url: The URL to which the token should be appended for the web view flow. The token replaces link_tokens in the URL. - rawRequest: Raw request data sent to the server, which may be empty.
- rawResponse: The raw response received from the Direct Deposit API, containing detailed data, including the token and other metadata.
- response: Contains a nested structure with the following information:
- data: An object containing:
- mode: The operational mode (e.g., "sandbox").
- id: A unique identifier for the token session.
- token: The generated link token, which must be included in the web view URL.
- smartBranchUrl: An optional URL for a smart branch (null if not applicable).
- expires: The expiration timestamp for the token.
- data: An object containing:
Usage:
- Token Generation: This API is used to generate a link token that is necessary for a customer to connect their financial accounts securely.
- Web View Integration: The token should be inserted into the specified URL (url field) for displaying the Direct Deposit connection flow in a web view.
- Session Management: The token expires after the specified time (expires), ensuring that connections are secure and time-limited.
Security Considerations:
- Authentication: Ensure that the request is authenticated to protect sensitive financial account information.
- Token Handling: Treat the generated token securely, as it grants access to link the user's financial accounts.
This API method is crucial for integrating with Direct Deposit, allowing users to link their financial accounts and access associated services efficiently.