Initiate Authorization Flow
curl --request POST \
--url https://api.atoa.me/api/bank/auth/initiate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"redirectUrl": "<string>",
"callbackParams": "<string>"
}'
{
"url": "https://atoa-link.com/link-bank?accountAuthId=ed016c93...&expiresAt=2025-04-16T17:53:48.174Z&env=PRODUCTION",
"accountAuthId": "ed016c93-68c2-4394-8e9c-1e700f8a1b15",
"expiresAt": "2025-04-16T17:53:48.174Z"
}
Before retrieving transactions, your users must authorize access to their bank accounts.
When using a sandbox secret key, all bank feed endpoints return static data and do not reflect real-time transactions.
Authorization
Bearer <token>
Request Body Schema
The URL your users will be redirected to after completing the account authorization flow.
Custom parameters you wish to pass through the flow. These will be appended as query parameters to the redirectUrl once the user completes the account authorization process.
Response
Use this to redirect your user to begin account authorization.
A unique identifier for tracking the authorization session. This ID will be
appended to the redirectUrl
after the account authorization flow is
completed.
If the link expires while in use, users will be redirected to the
redirectUrl
.
curl --request POST \
--url https://api.atoa.me/api/bank/auth/initiate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"redirectUrl": "<string>",
"callbackParams": "<string>"
}'
{
"url": "https://atoa-link.com/link-bank?accountAuthId=ed016c93...&expiresAt=2025-04-16T17:53:48.174Z&env=PRODUCTION",
"accountAuthId": "ed016c93-68c2-4394-8e9c-1e700f8a1b15",
"expiresAt": "2025-04-16T17:53:48.174Z"
}