> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/banks.md).

# Banks

Administrative endpoints for **banks** — the bank records that the rest of the payment configuration is built on. Both cards and bank transfer accounts are attached to a bank, and through the cards a bank indirectly carries the installment options offered to customers.

A bank consists of a display name, a unique slug that acts as its stable reference in integrations, and an optional logo.

### Core Capabilities

**1. Bank Listing & Filtering**

* Retrieve a paginated list of banks.
* Filter by identifier, name, or slug.
* Order the results by identifier, name, or slug.

**2. Bank Lifecycle Management**

* Create a bank with a display name and a unique slug.
* Update a bank fully or partially.
* Delete a bank, provided nothing else refers to it.

**3. Logo Handling**

* Upload a logo image directly as part of a multipart request.
* Or point the bank at an image that already exists in media storage by giving its storage path.

### Bank Fields

| Field       | Type             | Description                                                                                                                                                                                   |
| ----------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pk`        | integer          | The unique identifier of the bank. Assigned by the server; supplying it in a request body has no effect.                                                                                      |
| `name`      | string           | The display name of the bank. Required on create and on full update. Maximum 64 characters.                                                                                                   |
| `slug`      | string           | The unique reference of the bank. Required on create and on full update, optional on a partial update. Maximum 64 characters, and may contain only letters, digits, underscores, and hyphens. |
| `logo`      | string or `null` | In responses, the absolute URL of the bank's logo, or `null` when the bank has no logo. In requests, the image file itself, sent as a multipart upload.                                       |
| `logo_path` | string or `null` | Write-only. The storage path of an image that is already present in media storage, used instead of uploading a file. See **Logo Handling** below.                                             |

### Logo Handling

A bank's logo can be set in two ways, and both are optional:

* **Uploading a file** — send the request as `multipart/form-data` with the image in the `logo` field. The file is stored in media storage and the resulting address is returned in `logo`.
* **Referencing an existing file** — send `logo_path` with the storage path of a file that is already in media storage (for example `banks/example-bank.png`). No upload takes place; the bank is simply pointed at that file, and the resulting address is returned in `logo`.

When both are supplied in the same request, the uploaded file takes precedence and `logo_path` is ignored.

Two details are worth knowing when working with these fields:

* `logo_path` is an input-only field. It is present in every response, but its value is always `null` — the address the bank actually resolves to is reported in `logo`. Read the logo from `logo`, never from `logo_path`.
* On a full update, omitting both `logo` and `logo_path` leaves the current logo untouched rather than clearing it. There is no way to remove a logo through these endpoints once it has been set.

### Filtering & Ordering

Banks can be filtered with the `id`, `name`, and `slug` query parameters. Each is an **exact, case-sensitive** match — `?name=Example Bank` returns the bank, while `?name=example bank` returns an empty page. Partial-match and multi-value forms of these parameters are not available, and query parameters that are not listed here are ignored rather than rejected.

Results can be ordered with the `sort` parameter on `pk`, `name`, and `slug`. Prefix the field with a hyphen for descending order, and separate several fields with commas. Any other value is ignored and the default ordering is kept.

### Dynamic Settings & Environment Variables

No dynamic settings (`dj_dynamic_settings`) are read by these endpoints. Listing, filtering, creation, update, and deletion behave identically regardless of how the management panel is configured. The payment module's dynamic settings — such as the 3D Secure and installment settings — govern how payments are processed on the storefront and have no effect on the administrative endpoints in this section.

**Environment variables:** No environment variables are read directly by these endpoints. The only related server configuration is the platform's media storage configuration, which determines where an uploaded logo is stored and the address returned in the `logo` field.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/admin/banks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
