API Reference
update Changelog

Quickstart

Get up and running with Araucaria in 5 minutes. This guide walks you through connecting a bank account and fetching transaction data.

Prerequisites

  • An Araucaria API key (format: arau_xxxxxxxx)
  • A backend server to securely store your API key

Step 1: Create a Connection

From your backend, create a new connection to get a widget token:

bash
curl -X POST "https://api.araucaria.money/v1/connections" \
  -H "Authorization: Bearer arau_your_api_key" \
  -H "Content-Type: application/json"

Response:

json
{
  "connectionId": "conn_01HQ3K5J7X8Y9Z0A1B2C3D4E5F",
  "status": "CREATED",
  "widgetToken": "sess_abc123xyz..."
}

Step 2: Open the Widget

Pass the widgetToken to your frontend and open the widget:

html
<script src="https://api.araucaria.money/widget/araucaria-connect.js"></script>
<script>
  Araucaria.open({
    token: "sess_abc123xyz...",
    connectionId: "conn_01HQ3K5J7X8Y9Z0A1B2C3D4E5F",
    onSuccess: (metadata) => console.log('Connected!', metadata)
  });
</script>

Step 3: Receive Webhook

When the user completes authentication, Araucaria sends a webhook to your server:

json
{
  "event": "connection.connected",
  "connectionId": "conn_01HQ3K5J7X8Y9Z0A1B2C3D4E5F",
  "timestamp": "2024-01-15T10:32:00Z"
}

Step 4: Fetch Accounts

Once connected, fetch the user's accounts:

bash
curl "https://api.araucaria.money/v1/connections/conn_01HQ3K5J7X8Y9Z0A1B2C3D4E5F/accounts" \
  -H "Authorization: Bearer arau_your_api_key"

Step 5: Fetch Transactions

Get transaction history for a specific account:

bash
curl "https://api.araucaria.money/v1/accounts/acc_01HQ3K5J7X8Y9Z0A1B2C3D4E5F/transactions" \
  -H "Authorization: Bearer arau_your_api_key"
🎉 That's it!
You've successfully connected a bank account and fetched transactions. Check out the API Reference for all available endpoints.