Retrieve accounts for a client

GET /v1/clients/{clientId}/accounts

Base URL https://apicore.stg.finch.lat · operationId getAccounts

Returns a paginated list of accounts for the client. The Centralizing Account is identified by accountType = CENTRALIZING_ACCOUNT; private accounts are identified by accountType = PRIVATE_ACCOUNT.

Authorization

bearerAuth Bearer token

JWT bearer token created from client credentials. Use the Authentication guide to generate a token before calling protected endpoints.

Path parameters

clientId string required

Unique identifier of the client

Responses

200 Successful response with account details application/json

currentPage integer required

Current page number.

perPage integer required

Number of accounts returned per page.

totalItem integer required

Total number of accounts matching the request.

data array of Account required

Accounts associated with the client.

id data[].id string (uuid)

Fincore account UUID.

bankId data[].bankId string (uuid)

Bank UUID associated with the account.

clientId data[].clientId string (uuid)

Client UUID that owns the account relationship.

clientBankAdapterId data[].clientBankAdapterId string (uuid)

Bank adapter configuration UUID used by this account.

accountId data[].accountId string (uuid)

Core account UUID referenced by the account record.

instrumentId data[].instrumentId string (uuid)

Instrument UUID linked to the account and used for payment operations.

ownerId data[].ownerId string (uuid)

UUID of the entity that owns the account.

ownerType data[].ownerType string

Type of owner associated with the account.

CLIENT BUSINESS

accountNumber data[].accountNumber string

Internal account number without CLABE checksum context.

clabeNumber data[].clabeNumber string

CLABE associated with the account.

availableBalance data[].availableBalance string

Available balance as a decimal string with two decimals.

accountType data[].accountType string

Account type.

CENTRALIZING_ACCOUNT DISPERSION_ACCOUNT PRIVATE_ACCOUNT SAVINGS_ACCOUNT CHECKING_ACCOUNT

accountStatus data[].accountStatus string

Account lifecycle status.

ACTIVE BLOCKED SUSPENDED CANCELLED

audit data[].audit object

Account lifecycle timestamps.

createdAt data[].audit.createdAt string (date-time)

Timestamp when the resource was created.

updatedAt data[].audit.updatedAt string (date-time)

Timestamp when the resource was last updated.

deletedAt data[].audit.deletedAt string | null

Timestamp when the resource was deleted. When it was never deleted the API returns the literal string "None", not JSON null. Do not test this field for null.

blockedAt data[].audit.blockedAt string | null

Timestamp when the resource was blocked. When it was never blocked the API returns the literal string "None", not JSON null. Do not test this field for null.

activatedAt data[].audit.activatedAt string | null

Timestamp when the resource was activated, or null.

suspendedAt data[].audit.suspendedAt string | null

Timestamp when the resource was suspended, or null.

bankAdapter data[].bankAdapter string

Bank adapter that operates the account.

400 Account lookup request is invalid. Possible causes: malformed clientId path parameter or unsupported pagination/filter values. application/json

code integer required

gRPC status code mapped to HTTP.

message string required

General error message.

details array of ErrorDetail required

Detailed error causes returned by the service.

reason details[].reason string required

Machine-readable error category.

DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL

domain details[].domain string required

Service domain that produced the error.

metadata details[].metadata object required

Additional error metadata, including the detailed message and HTTP code.

error_detail details[].metadata.error_detail string

Human-readable detail returned by the service.

http_code details[].metadata.http_code string

HTTP status code associated with this error.

error_code details[].metadata.error_code string

Optional internal error catalog code when available.

401 Bearer token is missing, expired, invalid, or does not belong to the requested client. application/json

code integer required

gRPC status code mapped to HTTP.

message string required

General error message.

details array of ErrorDetail required

Detailed error causes returned by the service.

reason details[].reason string required

Machine-readable error category.

DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL

domain details[].domain string required

Service domain that produced the error.

metadata details[].metadata object required

Additional error metadata, including the detailed message and HTTP code.

error_detail details[].metadata.error_detail string

Human-readable detail returned by the service.

http_code details[].metadata.http_code string

HTTP status code associated with this error.

error_code details[].metadata.error_code string

Optional internal error catalog code when available.

500 Unexpected server error. See Error catalog before retrying non-idempotent operations. application/json

code integer required

gRPC status code mapped to HTTP.

message string required

General error message.

details array of ErrorDetail required

Detailed error causes returned by the service.

reason details[].reason string required

Machine-readable error category.

DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL

domain details[].domain string required

Service domain that produced the error.

metadata details[].metadata object required

Additional error metadata, including the detailed message and HTTP code.

error_detail details[].metadata.error_detail string

Human-readable detail returned by the service.

http_code details[].metadata.http_code string

HTTP status code associated with this error.

error_code details[].metadata.error_code string

Optional internal error catalog code when available.

This request is in the Monato · Fincore Postman collection, folder Accounts.Download collection

Request

curl -X GET "https://apicore.stg.finch.lat/v1/clients/{clientId}/accounts" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://apicore.stg.finch.lat/v1/clients/{clientId}/accounts", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${TOKEN}`,
  },
});
const data = await res.json();

import requests

res = requests.get(
    "https://apicore.stg.finch.lat/v1/clients/{clientId}/accounts",
    headers={
        "Authorization": f"Bearer {TOKEN}",
    },
)
data = res.json()

Response

{
  "currentPage": 1,
  "perPage": 50,
  "totalItem": 1,
  "data": [
    {
      "id": "24a726ac-180d-48df-82bc-711f2788a46f",
      "bankId": "9d84b03a-28d1-4898-a69c-38824239e2b1",
      "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "clientBankAdapterId": "5b3a1b67-ab59-4cc1-8fc6-1d558b32b237",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "instrumentId": "709448c3-7cbf-454d-a87e-feb23801269a",
      "ownerId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "ownerType": "CLIENT",
      "accountNumber": "000001000004",
      "clabeNumber": "734180000001000004",
      "availableBalance": "0.00",
      "accountType": "PRIVATE_ACCOUNT",
      "accountStatus": "ACTIVE",
      "audit": {
        "createdAt": "2025-03-05 11:00:56.264527-06:00",
        "updatedAt": "2025-03-05 11:00:56.264527-06:00",
        "deletedAt": "None",
        "blockedAt": "None",
        "activatedAt": null,
        "suspendedAt": null
      },
      "bankAdapter": "SIES"
    }
  ]
}

{
  "code": 9,
  "message": "API Error",
  "details": [
    {
      "reason": "FAILED_PRECONDITION",
      "domain": "CORE",
      "metadata": {
        "error_detail": "The account does not have sufficient funds.",
        "http_code": "400",
        "error_code": "10-E4120"
      }
    }
  ]
}

{
  "code": 9,
  "message": "API Error",
  "details": [
    {
      "reason": "FAILED_PRECONDITION",
      "domain": "CORE",
      "metadata": {
        "error_detail": "The account does not have sufficient funds.",
        "http_code": "400",
        "error_code": "10-E4120"
      }
    }
  ]
}

{
  "code": 9,
  "message": "API Error",
  "details": [
    {
      "reason": "FAILED_PRECONDITION",
      "domain": "CORE",
      "metadata": {
        "error_detail": "The account does not have sufficient funds.",
        "http_code": "400",
        "error_code": "10-E4120"
      }
    }
  ]
}