Browse the API30

bank-link

get

/api/v1/bank-link/{id}/transactions

The ingested bank transactions for the case behind one bank-verification request, paginated.

Scope: cases:read
Rate limit: 100 requests / min
Idempotency: read-only

Authentication

Send your key as Authorization: Bearer …. It must carry the scope cases:read; a key without it receives 403 forbidden.

Path parameters

idstringrequired

Query parameters

date_fromstringpattern ^\d{4}-\d{2}-\d{2}$

date_tostringpattern ^\d{4}-\d{2}-\d{2}$

min_amountstring

pageintegerdefault 1min 1

per_pageintegerdefault 25min 1max 100

typestring

Request body

This operation takes no request body.

Response

200application/json

dataSerializedBankTransaction[]required

paginationobjectrequired

pagenumberrequired

per_pagenumberrequired

totalnumberrequired

total_pagesnumberrequired

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

400validation_error

401unauthorized

403forbidden

404not_found

429rate_limit_exceeded

500internal_error

Request

curl -X GET "https://<your-host>/api/v1/bank-link/<id>/transactions?page=1&per_page=25" \
  -H "Authorization: Bearer hlh_test_YOUR_API_KEY"

Response200application/json

{
  "data": [
    {
      "id": string,
      "date": string | null,
      "description": string,
      "amount": number,
      "type": string,
      "category": string,
      "merchant_name": string | null
    }
  ],
  "pagination": {
    "page": number,
    "per_page": number,
    "total": number,
    "total_pages": number
  }
}

Shown as types, not sample values. A field typed number | null can be null; the response fields table gives the reason.