Skip to content

Latest commit

 

History

History
11 lines (8 loc) · 1.9 KB

TaskPayload.md

File metadata and controls

11 lines (8 loc) · 1.9 KB

# TaskPayload

Properties

Name Type Description Notes
bank_connection_id int Identifier of the bank connection in the Access API. Initialized as soon as the task process is started. Use those ID to gather Bank Connection data from Access endpoints like, &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#get-/api/v1/bankConnections/-id-&#39;&gt;Get a bank connection</a>&quot; or &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#get-/api/v1/accounts&#39;&gt;Get and search all accounts</a>&quot;.
web_form \OpenAPIWebForm\Client\Model\WebFormInfo [optional]
error_code string Reason of the task failure.<br/><strong>NOTE:</strong> This enum can be extended in the future as new cases arise!<br/><br/>Codes can be interpreted as follows:<br/>&bull; <code>BANK_SERVER_REJECTION</code> - the flow has been terminated on the bank side, e.g., in case of incorrect credentials;<br/>&bull; <code>INVALID_TOKEN</code> - the given access token expired or became invalid during the flow; <br/>&bull; <code>UNEXPECTED_ACCESS_RESPONSE</code> - an unexpected response has been received from the Access API - similarly to the <code>INTERNAL_ERROR</code> code, please forward all details to our Customer Support team; <br/>&bull; <code>INTERNAL_ERROR</code> - the reason of the failure can not be identified - please forward all the details to our Customer Support team in order to get more info and also help us to eliminate the issue. [optional]

[Back to Model list] [Back to API list] [Back to README]