POST /v1/banks — Create and Register an In-Game Bank

Use this endpoint to register a new in-game bank on the CA Colombia platform. Banks are owned by a specific character and hold capital that funds their operations. When you create a bank you can optionally specify a starting capital amount; if omitted, the bank is created with zero capital.

Creating a bank requires the SERVICE_ADMINISTRATOR permission. This is a privileged operation reserved for platform administrators — it is not available to regular users.

Endpoint

POST https://api.cacolombia.com/v1/banks

Request Body

string

required

The characterId (Snowflake ID) of the character who will own the new bank. The character must already exist in the system.

string

required

The display name for the bank.

number

The initial capital balance for the bank, in in-game currency units. Defaults to 0 if omitted.

Response

A successful 201 Created response returns the newly created 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, or null if no icon has been set. Use this with the images endpoint to retrieve the icon.

number

The bank’s current capital balance.

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 POST "https://api.cacolombia.com/v1/banks" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "ownerId": "998877665544332211",
    "name": "Banco Nacional",
    "capital": 1000000
  }'

Example Response

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

Error Responses

Status	Description
`400`	The request body is missing `ownerId` or `name`, or contains values of the wrong type.
`401`	You are not authenticated. Provide a valid authorization token with your request.
`403`	Your account does not hold the `SERVICE_ADMINISTRATOR` permission.
`404`	No character was found for the given `ownerId`.

Overview

Auth & OAuth

Users

Characters

Economy

Banking

Staff

Utilities

POST /v1/banks — Create and Register an In-Game Bank

Endpoint

Request Body

Response

Example Request

Example Response

Error Responses

​Endpoint

​Request Body

​Response

​Example Request

​Example Response

​Error Responses

Endpoint

Request Body

Response

Example Request

Example Response

Error Responses