GET /v1/banks/:bankId — Retrieve Bank Information

Use this endpoint to look up a specific in-game bank by its ID. The response includes the bank’s name, current capital, icon hash, and the character ID of its owner. Any authenticated user with at least the USER permission can call this endpoint.

Endpoint

GET https://api.cacolombia.com/v1/banks/:bankId

Path Parameters

string

required

The Snowflake ID of the bank you want to retrieve.

Response

A successful 200 response returns the bank object:

string

The unique Snowflake ID for this bank.

string

The characterId of the character who owns the bank.

string

The display name of the bank.

string | null

The hash of the bank’s icon image. Pass this value to the images endpoint using type icons to retrieve the image. Returns null if no icon has been uploaded.

number

The bank’s current capital balance in in-game currency units.

string

ISO 8601 timestamp of when the bank was created.

string

ISO 8601 timestamp of when the bank was last modified.

Example Request

curl -X GET "https://api.cacolombia.com/v1/banks/112233445566778800" \
  -H "Authorization: Bearer <your_token>"

Example Response

{
  "bankId": "112233445566778800",
  "ownerId": "998877665544332211",
  "name": "Banco Nacional",
  "iconHash": "a3f2c1d4e5b6789012345678abcdef0123456789abcdef0123456789abcdef01",
  "capital": 1000000,
  "createdAt": "2024-06-01T08:00:00.000Z",
  "updatedAt": "2024-06-05T12:30:00.000Z"
}

Error Responses

Status	Description
`401`	You are not authenticated. Provide a valid authorization token with your request.
`404`	No bank was found for the given `bankId`.

Overview

Auth & OAuth

Users

Characters

Economy

Banking

Staff

Utilities

GET /v1/banks/:bankId — Retrieve Bank Information

Endpoint

Path Parameters

Response

Example Request

Example Response

Error Responses

​Endpoint

​Path Parameters

​Response

​Example Request

​Example Response

​Error Responses

Endpoint

Path Parameters

Response

Example Request

Example Response

Error Responses