Explorar a referência

Ligações bancárias

15 endpoints · As descrições dos endpoints estão em inglês.

List bank accounts in the household

GET/households/{householdId}/bank-accounts

read:banking

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/bank-accounts

Resposta200 · Success

Pause / resume sync for one bank account

PATCH/households/{householdId}/bank-accounts/{id}

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/bank-accounts/{id}

Resposta200 · Success

Unlink a bank account from its vokse account (the account and imported transactions stay; new movements stop arriving until mapped again)

DELETE/households/{householdId}/bank-accounts/{id}/link

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/bank-accounts/{id}/link

Resposta200 · Success

Map a bank account to an existing financial_account or create a new one

POST/households/{householdId}/bank-accounts/{id}/map

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/bank-accounts/{id}/map

Resposta200 · Success

Move the financial_account link to a different one

PATCH/households/{householdId}/bank-accounts/{id}/relink

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/bank-accounts/{id}/relink

Resposta200 · Success

List bank connections in the household

GET/households/{householdId}/bank-connections

read:banking

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/bank-connections

Resposta200 · Success

Start a bank connection (row is `pending` until completed): returns a redirect URL (redirect flow) or a link token (widget flow); institution is optional for Plaid, required for Enable Banking; optional clientPlatform (web by default, ios, android) picks the Plaid OAuth return

POST/households/{householdId}/bank-connections

write:banking

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/bank-connections

Resposta200 · Success

Fetch a single bank connection

GET/households/{householdId}/bank-connections/{id}

read:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/bank-connections/{id}

Resposta200 · Success

Soft-delete a bank connection

DELETE/households/{householdId}/bank-connections/{id}

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/bank-connections/{id}

Resposta204 · No content

Finalize a connection after the provider auth flow; optional exchangeToken (Enable Banking code / Plaid public_token); persists accounts

POST/households/{householdId}/bank-connections/{id}/complete

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/bank-connections/{id}/complete

Resposta200 · Success

Quota usage snapshot for this connection (today, UTC)

GET/households/{householdId}/bank-connections/{id}/quota

read:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/bank-connections/{id}/quota

Resposta200 · Success

Re-authorize the same institution on this connection: Plaid Link update mode when the connection already holds a credential, otherwise a fresh requisition (90-day consent renewal); optional redirectUrl on our origin and clientPlatform (web by default, ios, android)

POST/households/{householdId}/bank-connections/{id}/reauth

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/bank-connections/{id}/reauth

Resposta200 · Success

On-demand sync for this connection (rate-limited to 1/day per connection; 409 while a sync is running or the link is still pending)

POST/households/{householdId}/bank-connections/{id}/sync

write:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/bank-connections/{id}/sync

Resposta200 · Success

List sync run history for this connection

GET/households/{householdId}/bank-connections/{id}/sync-runs

read:banking

Parâmetros

Nome	Local	Obrigatório
id	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/bank-connections/{id}/sync-runs

Resposta200 · Success

List available bank institutions for a country (region-routed provider, ADR 0048)

GET/households/{householdId}/banking/institutions

read:banking

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/banking/institutions

Resposta200 · Success