POST
/
api
/
bank
/
auth
/
initiate
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?referenceId=ed016c93...&expiresAt=2025-04-16T17:53:48.174Z&env=PRODUCTION",
  "referenceId": "ed016c93-68c2-4394-8e9c-1e700f8a1b15",
  "expiresAt": "2025-04-16T17:53:48.174Z"
}

Before retrieving transactions, your users must authorize access to their bank accounts.

AUTHORIZATION: Bearer <token>

REQUEST BODY SCHEMA

redirectUrl
string
required

The URL your users will be redirected to after completing the account authorization flow.

callbackParams
string

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

url
string

Use this to redirect your user to begin account authorization.

referenceId
string

A unique identifier for tracking the authorization session. This ID will be appended to the redirectUrl after the account authorization flow is completed.

expiresAt
string

If the link expires while in use, users will be redirected to the redirectUrl.

Refund Status Webhook response PayloadRetrieve Bank Transactions