Fincore · API reference · Catalogs
Retrieve catalog of SPEI participants
Base URL https://apicore.stg.finch.lat · operationId retrieveBanksCatalog
Returns a paginated list of bank and institutions that are part of the SPEI Network.
Authorization
JWT bearer token created from client credentials. Use the Authentication guide to generate a token before calling protected endpoints.
Responses
200 A list of institutions application/json
total_banks integer requiredTotal number of institutions available in the catalog.
page integer requiredCurrent page number.
page_size integer requiredNumber of institutions returned per page.
banks array of Bank requiredSPEI participant institutions.
id banks[].id string (uuid) Bank identifier used by Fincore APIs.
name banks[].name string Institution display name.
token banks[].token string SPEI institution token used by the adapter.
BIM banks[].BIM string Bank identifier used by the SPEI participant catalog.
code banks[].code string Full institution code used for SPEI routing.
bank_status banks[].bank_status string Whether the institution is available for routing.
ACTIVE INACTIVE 401 Bearer token is missing, expired, invalid, or not valid for the requested environment. application/json
code integer requiredgRPC status code mapped to HTTP.
message string requiredGeneral error message.
details array of ErrorDetail requiredDetailed error causes returned by the service.
reason details[].reason string requiredMachine-readable error category.
DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL domain details[].domain string requiredService domain that produced the error.
metadata details[].metadata object requiredAdditional 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 requiredgRPC status code mapped to HTTP.
message string requiredGeneral error message.
details array of ErrorDetail requiredDetailed error causes returned by the service.
reason details[].reason string requiredMachine-readable error category.
DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL domain details[].domain string requiredService domain that produced the error.
metadata details[].metadata object requiredAdditional 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.
Request
curl -X GET "https://apicore.stg.finch.lat/v1/banks" \
-H "Authorization: Bearer $TOKEN"const res = await fetch("https://apicore.stg.finch.lat/v1/banks", {
method: "GET",
headers: {
"Authorization": `Bearer ${TOKEN}`,
},
});
const data = await res.json();import requests
res = requests.get(
"https://apicore.stg.finch.lat/v1/banks",
headers={
"Authorization": f"Bearer {TOKEN}",
},
)
data = res.json()Response
{
"total_banks": 1,
"page": 1,
"page_size": 50,
"banks": [
{
"id": "9d84b03a-28d1-4898-a69c-38824239e2b1",
"name": "FINCO_PAY",
"token": "734",
"BIM": "734",
"code": "90734",
"bank_status": "ACTIVE"
}
]
}{
"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"
}
}
]
}