### GET Payments Request Example (cURL)

Source: https://developers.kobana.com.br/v2.0/reference/recebimentos

This snippet demonstrates how to make a GET request to retrieve a list of payments using cURL. It includes the necessary URL, headers, and parameters for the request. Ensure you have the correct API key for authentication.

```shell
curl --request GET \
     --url 'https://api-sandbox.kobana.com.br/v2/charge/payments?per_page=50' \
     --header 'accept: application/json'
```

--------------------------------

### GET /websites/developers_kobana_br_v2_0_reference (Example 404 Not Found)

Source: https://developers.kobana.com.br/v2.0/reference/put_v2-charge-automatic-pix-pix-uid-cancel-1

Example of a 404 Not Found response when a specific PIX automatic charge cannot be located.

```APIDOC
## GET /websites/developers_kobana_br_v2_0_reference

### Description
This endpoint is used to retrieve details about a PIX automatic charge. The example below demonstrates a 404 Not Found error response.

### Method
GET

### Endpoint
`/websites/developers_kobana_br_v2_0_reference`

### Response
#### Error Response (404)
- **status** (integer) - The HTTP status code, which is 404.
- **errors** (array) - An array containing error details.
    - **title** (string) - A description of the error. Example: `Could not find the record`.
    - **code** (string) - An error code. Example: `not_found`.

#### Response Example (404)
```json
{
  "status": 404,
  "errors": [
    {
      "title": "Could not find the record",
      "code": "not_found"
    }
  ]
}
```
```

--------------------------------

### Retrieve Transfer Accounts - Python Example

Source: https://developers.kobana.com.br/v2.0/reference/contas-de-transfer%C3%AAncia

A Python example demonstrating how to retrieve transfer accounts. This code utilizes the 'requests' library to perform a GET request and handle the JSON response.

```python
import requests

url = "https://api-sandbox.kobana.com.br/v2/transfer/accounts?per_page=50"
headers = {
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
    print(response.text)
```

--------------------------------

### JSON Object Example

Source: https://developers.kobana.com.br/v2.0/reference/get_v2-transfer-pix-1

This snippet demonstrates the structure of a JSON object with key-value pairs, including a nullable field and an example with a nested JSON string.

```json
{
  "type": "object",
  "nullable": true,
  "example": "{\"codigo\": \"123\", \"vip\": true}",
  "description": "Hash com chave e valor no formato JSON."
}
```

--------------------------------

### Resource Type Examples in Python

Source: https://developers.kobana.com.br/v2.0/reference/put_v2-edi-edi-boxes-uid

Demonstrates how to represent different resource types within a Python object. This includes financial accounts and charge accounts, specifying their unique identifiers.

```python
resource_financial_account = {
    "type": "financial.account",
    "uid": "01948afe-3014-7e81-9a88-badcfc1fd4d6"
}

resource_charge_account = {
    "type": "charge.bank_billet_account",
    "uid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

--------------------------------

### Retrieve Transfer Accounts - PHP Example

Source: https://developers.kobana.com.br/v2.0/reference/contas-de-transfer%C3%AAncia

A PHP example for retrieving transfer accounts using cURL. This code sets up the cURL request, including the URL and headers, and then executes it to get the API response.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, "https://api-sandbox.kobana.com.br/v2/transfer/accounts?per_page=50");
curl_setopt($curl, CURLOPT_HTTPHEADER, array('accept: application/json'));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #" . $err;
} else {
  echo $response;
}
```

--------------------------------

### POST /websites/developers_kobana_br_v2_0_reference/transfers/batch

Source: https://developers.kobana.com.br/v2.0/reference/post_v2-transfer-internal-batches-1

Cria um novo lote de transferências entre contas.

```APIDOC
## POST /websites/developers_kobana_br_v2_0_reference/transfers/batch

### Description
Cria um novo lote de transferências entre contas.

### Method
POST

### Endpoint
/websites/developers_kobana_br_v2_0_reference/transfers/batch

### Parameters
#### Request Body
- **items** (array) - Required - Lista de itens para transferência.
  - **origin_account_uid** (string) - Required - UID da Conta Financeira de Origem.
  - **external_id** (string) - Optional - ID no seu sistema. Opcional para controle interno.
  - **custom_data** (object) - Optional - Hash com chave e valor no formato JSON.
  - **tags** (array) - Optional - Tags associadas.
    - **items** (string) - Exemplo: tag1
  - **beneficiary** (object) - Required - Dados do Recebedor.
    - **document_number** (string) - Required - Número do Documento (CPF ou CNPJ).
    - **name** (string) - Required - Nome Completo ou Razão Social.
  - **internal** (object) - Required - Dados bancários.
    - **agency_number** (string) - Required - Número da Agência.
    - **agency_digit** (string) - Required - Dígito da Agência.
    - **account_number** (string) - Required - Número da Conta.
    - **account_digit** (string) - Required - Dígito da Conta.
- **existing_transfer** (object) - Required - Transferência existente.
  - **uid** (string) - Required - UID de uma Transferência.

### Request Example
```json
{
  "items": [
    {
      "origin_account_uid": "018df180-7208-727b-a10a-ea545e4a75a8",
      "external_id": "123456-abc-789",
      "custom_data": {"codigo": "123", "vip": true},
      "tags": ["tag1"],
      "beneficiary": {
        "document_number": "CPF_OU_CNPJ",
        "name": "Nome Completo ou Razão Social"
      },
      "internal": {
        "agency_number": "1234",
        "agency_digit": "0",
        "account_number": "12345",
        "account_digit": "0"
      }
    }
  ],
  "existing_transfer": {
    "uid": "018df180-7208-727b-a10a-ea545e4a75a8"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Status da operação.
- **message** (string) - Mensagem de retorno.

#### Response Example
```json
{
  "status": "success",
  "message": "Lote de transferência criado com sucesso."
}
```
```

--------------------------------

### Visualizar Importação de Extrato

Source: https://developers.kobana.com.br/v2.0/reference/get_v2-financial-accounts-financial-account-uid-statement-transactions-imports-uid-1

Obtém informações detalhadas sobre uma importação de extrato específica.

```APIDOC
## GET /websites/developers_kobana_br_v2_0_reference/importacao_extrato

### Description
Consulta informações específicas de uma Importação de Extrato.

### Method
GET

### Endpoint
/websites/developers_kobana_br_v2_0_reference/importacao_extrato

### Parameters

#### Query Parameters
- **id** (integer) - Required - O ID da importação de extrato a ser consultada.

### Request Example
```
GET /websites/developers_kobana_br_v2_0_reference/importacao_extrato?id=12345
```

### Response
#### Success Response (200)
- **id** (integer) - O ID da importação.
- **data_criacao** (string) - A data de criação da importação no formato ISO 8601.
- **status** (string) - O status atual da importação (ex: "concluida", "em_andamento", "falhou").
- **nome_arquivo** (string) - O nome do arquivo de extrato importado.
- **total_registros** (integer) - O número total de registros processados na importação.
- **registros_sucesso** (integer) - O número de registros importados com sucesso.
- **registros_falha** (integer) - O número de registros que falharam durante a importação.

#### Response Example
```json
{
  "id": 12345,
  "data_criacao": "2023-10-27T10:30:00Z",
  "status": "concluida",
  "nome_arquivo": "extrato_202310.csv",
  "total_registros": 1000,
  "registros_sucesso": 998,
  "registros_falha": 2
}
```
```

--------------------------------

### Retrieve Transfer Accounts - Node.js Example

Source: https://developers.kobana.com.br/v2.0/reference/contas-de-transfer%C3%AAncia

Example of how to fetch transfer accounts using Node.js. This code snippet would typically use a library like 'axios' or the built-in 'fetch' to make the GET request to the API.

```javascript
// Assumes an 'axios' instance is configured or 'fetch' is available
// Example using fetch:
fetch('https://api-sandbox.kobana.com.br/v2/transfer/accounts?per_page=50', {
  method: 'GET',
  headers: {
    'accept': 'application/json',
    'authorization': 'Bearer YOUR_API_TOKEN' // Add authentication header
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

--------------------------------

### Utility Payments Response Example (JSON)

Source: https://developers.kobana.com.br/v2.0/reference/contas-de-consumo

This is an example JSON response for the /v2/payment/utilities endpoint. It illustrates the structure of a successful response, including the status code and a list of payment objects. Each payment object contains details like UID, amount, status, financial account UID, and utility information.

```JSON
{
  "status": 200,
  "data": [
    {
      "uid": "019b7c10-4c87-73d5-8e3f-138ef56e19c4",
      "amount": 100,
      "scheduled_to": "2026-01-02T12:16:41+12:00",
      "status": "pending",
      "registration_status": "pending",
      "financial_account_uid": "019b7c10-4c73-7eac-9c81-888e79454c72",
      "confirmed_at": null,
      "rejected_error": null,
      "rejected_at": null,
      "transaction_code": null,
      "transaction_date": null,
      "source": "view",
      "identifier": null,
      "external_id": null,
      "custom_data": null,
      "tags": [],
      "tag_list": null,
      "created_at": "2026-01-02T12:16:41+12:00",
      "updated_at": "2026-01-02T12:16:41+12:00",
      "utility": {
        "code": "01990132406678568280805043052611964265028462",
        "beneficiary": {
          "name": "Margret Santos LTDA",
          "document_number": "34.414.342/0000-99"
        }
      }
    },
    {
      "uid": "019b7c10-4c58-7c84-86e6-d958f786c06d",
      "amount": 100,
      "scheduled_to": "2026-01-02T12:16:41+12:00",
      "status": "pending",
      "registration_status": "pending",
      "financial_account_uid": "019b7c10-4c44-71be-b9bd-d4aee7d57e92",
      "confirmed_at": null,
      "rejected_error": null
    }
  ]
}
```

--------------------------------

### Create Utility Payment Batch (JSON)

Source: https://developers.kobana.com.br/v2.0/reference/post_v2-payment-utility-batches-1

This endpoint is used to create a payment batch for utility bills. It requires a financial account to be registered beforehand. Webhook events like `payment.batch.db.created` and `payment.utility_batch.confirmed` are triggered upon successful batch creation and confirmation. The `User-Agent` and `X-Idempotency-Key` headers are optional but recommended for tracking and preventing duplicate requests.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Pagamentos",
    "version": "v2",
    "description": "A KOBANA fornece uma API simples e poderosa em REST para integrar pagamentos por PIX e boletos bancários em seu site ou aplicação.",
    "termsOfService": "https://l.kobana.com.br/termos-uso",
    "contact": {
      "name": "Suporte de API",
      "url": "https://ajuda.kobana.com.br",
      "email": "suporte@kobana.com.br"
    }
  },
  "servers": [
    {
      "url": "https://{apiHost}/",
      "variables": {
        "apiHost": {
          "enum": [
            "api-sandbox.kobana.com.br",
            "api.kobana.com.br"
          ],
          "default": "api-sandbox.kobana.com.br"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "paths": {
    "/v2/payment/utility_batches": {
      "post": {
        "summary": "Criar um Lote de Pagamento de Contas de Consumo",
        "tags": [
          "Contas de Consumo"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "description": "\nEsse endpoint é utilizado para a geração de um lote de pagamento.\n\n## Pré-requisito\n\nPara emitir um pagamento é necessário ter cadastrado um Conta Financeira.\n\n## Eventos de Webhook\n\nO evento `payment.batch.db.created` é disparado nesta operação.\n\nAo cadastrar um Lote de Pagamento, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento `payment.utility_batch.confirmed` é disparado.\n\nO evento `payment.db.created` também é disparado nesta operação caso o lote contenha um novo pagamento.",
        "parameters": [
          {
            "name": "User-Agent",
            "in": "header",
            "required": false,
            "description": "Informar um e-mail válido para contatos.",
            "example": "Kevin Mitnick <kmitnick@kobana.com.br>",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "Chave de idempotência para evitar replay de processamento.",
            "example": "4wE7HVG5rW3R7Xg1",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Lote de Pagamento criado",
            "content": {
              "application/json": {
                "example": {
                  "status": 201,
                  "data": {
                    "uid": "019b7c10-5038-794c-a220-17501f7b457f",
                    "status": "pending",
                    "registration_status": "pending",
                    "financial_account_uid": "019b7c10-501d-7db2-aa22-033f1fa7f00d",
                    "created_at": "2026-01-02T12:16:42+12:00",
                    "updated_at": "2026-01-02T12:16:42+12:00",
                    "payments": [
                      {
                        "uid": "019b7c10-5037-7780-99e1-3fac57b3fa41",
                        "amount": 100.4,
                        "scheduled_to": null,
                        "status": "pending",
                        "registration_status": "pending",
                        "financial_account_uid": "019b7c10-501d-7db2-aa22-033f1fa7f00d",
                        "confirmed_at": null,
                        "rejected_error": null,
                        "rejected_at": null,
                        "transaction_code": null,
                        "transaction_date": null,
                        "source": "api",
                        "identifier": null,
                        "external_id": null,
                        "custom_data": null,
                        "tags": [],
                        "tag_list": null,
                        "created_at": "2026-01-02T12:16:42+12:00",
                        "updated_at": "2026-01-02T12:16:42+12:00",
                        "utility": {
                          "code": "00196994400000100040000003128557120985944917",
                          "beneficiary": {
                            "name": null,
                            "document_number": "34.414.342/0000-99"
                          }
                        }
                      },
                      {
                        "uid": "019b7c10-5038-7909-b723-7c129c500d6d",
                        "amount": 100.4,
                        "scheduled_to": null,
                        "status": "pending",
                        "registration_status": "pending",
                        "financial_account_uid": "019b7c10-501d-7db2-aa22-033f1fa7f00d",
                        "confirmed_at": null,
                        "rejected_error": null,
                        "rejected_at": null,
                        "transaction_code": null,
                        "transaction_date": null,
                        "source": "api",
                        "identifier": null,
                        "external_id": null,
                        "custom_data": null,
                        "tags": [],
                        "tag_list": null,
                        "created_at": "2026-01-02T12:16:42+12:00",
                        "updated_at": "2026-01-02T12:16:42+12:00",
                        "utility": {
                          "code": "00196994400000100040000003128557120985944917",
                          "beneficiary": {
                            "name": null,
                            "document_number": "34.414.342/0000-99"
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### HTTP 422 Unprocessable Entity - Connection Error Example

Source: https://developers.kobana.com.br/v2.0/reference/post_v2-financial-accounts-financial-account-uid-statement-transactions-sync-1

Provides an example JSON response for a `422 Unprocessable Entity` HTTP status code, specifically indicating that the 'Connection for Statement' is not active. This error suggests a configuration or setup issue preventing the requested operation.

```json
{
  "status": "error",
  "errors": [
    {
      "title": "Conexão para Extrato não ativa",
      "code": "unprocessable_entity",
      "param": null,
      "detail": null
    }
  ]
}
```

--------------------------------

### Successful GET Payments Response (JSON)

Source: https://developers.kobana.com.br/v2.0/reference/recebimentos

This is an example of a successful JSON response when retrieving payments. It includes pagination details and a list of payment objects, each with various attributes like UID, debtor information, amount, and status.

```json
{
  "status": 200,
  "data": [
    {
      "uid": "019b7c0f-d08d-7d52-8c19-b0383c45153a",
      "payable": {
        "id": 296,
        "uid": "019b7c0f-d086-74dc-9bf1-331919cebef7",
        "type": "BankBillet"
      },
      "debtor": {
        "is_payer": null,
        "name": "José da Silva",
        "document_number": "399.881.072-26"
      },
      "payer": null,
      "amount": 1,
      "paid_at": "2026-01-02",
      "credit_at": null,
      "kind": "direct",
      "bank": null,
      "receiving": {
        "bank": null,
        "agency": null
      },
      "created_via_api": false,
      "transaction_identifier": null,
      "status": "confirmed",
      "created_at": "2026-01-02T12:16:09+12:00",
      "updated_at": "2026-01-02T12:16:09+12:00"
    }
  ],
  "pagination": {
    "prev_url": "/v2/charge/payments?kind=direct&page=&per_page=50",
    "next_url": "/v2/charge/payments?kind=direct&page=&per_page=50",
    "page": 1
  }
}
```

--------------------------------

### PUT /websites/developers_kobana_br_v2_0_reference

Source: https://developers.kobana.com.br/v2.0/reference/patch_v2-charge-automatic-pix-requests-uid-1

Atualiza as informações de uma solicitação PIX automática existente. É necessário fornecer os dados que deseja modificar.

```APIDOC
## PUT /websites/developers_kobana_br_v2_0_reference

### Description
Atualiza informações de uma solicitação PIX automática existente.

### Method
PUT

### Endpoint
/websites/developers_kobana_br_v2_0_reference

### Parameters
#### Request Body
- **id** (string) - Required - ID da solicitação PIX automática a ser atualizada.
- **status** (string) - Optional - Novo status da solicitação (ex: "ATIVA", "INATIVA").
- **valor** (number) - Optional - Novo valor da solicitação.

### Request Example
```json
{
  "id": "pix_auto_12345",
  "status": "INATIVA",
  "valor": 50.75
}
```

### Response
#### Success Response (200)
- **message** (string) - Mensagem indicando o sucesso da atualização.

#### Response Example
```json
{
  "message": "Solicitação PIX automática atualizada com sucesso."
}
```
```

--------------------------------

### GET /websites/developers_kobana_br_v2_0_reference

Source: https://developers.kobana.com.br/v2.0/reference/get_v2-transfer-pix-uid-1

Consulta informações específicas de uma Transferência Pix.

```APIDOC
## GET /websites/developers_kobana_br_v2_0_reference

### Description
Consulta informações específicas de uma Transferência Pix.

### Method
GET

### Endpoint
/websites/developers_kobana_br_v2_0_reference

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **PixTransfer** (object) - Informações detalhadas da Transferência Pix.

#### Response Example
```json
{
  "PixTransfer": {
    "id": "transfer_id_123",
    "status": "completed",
    "amount": 100.50,
    "currency": "BRL",
    "createdAt": "2023-10-27T10:00:00Z",
    "recipient": {
      "name": "John Doe",
      "taxId": "12345678900"
    },
    "sender": {
      "name": "Jane Smith",
      "taxId": "09876543210"
    },
    "transactionId": "pix_txid_abcde12345"
  }
}
```
```

--------------------------------

### List Utility Payments (cURL)

Source: https://developers.kobana.com.br/v2.0/reference/contas-de-consumo

This snippet shows how to make a GET request to the /v2/payment/utilities endpoint using cURL to retrieve a list of utility payments. It includes the base URL and an example of setting the 'per_page' query parameter.

```Shell
curl --request GET \
     --url 'https://api-sandbox.kobana.com.br/v2/payment/utilities?per_page=50' \
     --header 'accept: application/json'
```

--------------------------------

### Get Automatic Pix Locations (cURL)

Source: https://developers.kobana.com.br/v2.0/reference/pix-autom%C3%A1tico-location

This cURL command retrieves a list of automatic Pix locations from the Kobana API. It requires an 'accept' header for JSON response. No specific authentication method is shown in this example, but API keys are mentioned as a prerequisite.

```bash
curl --request GET \
     --url https://api-sandbox.kobana.com.br/v2/charge/automatic_pix/locations \
     --header 'accept: application/json'
```

--------------------------------

### GET /websites/developers_kobana_br_v2_0_reference/lote-transferencia

Source: https://developers.kobana.com.br/v2.0/reference/get_v2-transfer-batches-uid-1

Consulta informações específicas de um Lote de Transferência.

```APIDOC
## GET /websites/developers_kobana_br_v2_0_reference/lote-transferencia

### Description
Consulta informações específicas de um Lote de Transferência.

### Method
GET

### Endpoint
/websites/developers_kobana_br_v2_0_reference/lote-transferencia

### Parameters
#### Query Parameters
- **id** (integer) - Required - ID do lote a ser consultado.

### Response
#### Success Response (200)
- **id** (integer) - O ID único do lote de transferência.
- **data_criacao** (string) - A data e hora em que o lote foi criado (formato ISO 8601).
- **status** (string) - O status atual do lote (ex: "PROCESSANDO", "CONCLUIDO", "FALHA").
- **total_itens** (integer) - O número total de itens incluídos no lote.
- **itens_processados** (integer) - O número de itens que já foram processados.
- **mensagem_erro** (string) - Uma mensagem de erro detalhada, se o lote falhar.

#### Response Example
```json
{
  "id": 12345,
  "data_criacao": "2023-10-27T10:30:00Z",
  "status": "CONCLUIDO",
  "total_itens": 100,
  "itens_processados": 100,
  "mensagem_erro": null
}
```
```

--------------------------------

### Making an API Request with Access Token (cURL)

Source: https://developers.kobana.com.br/v2.0/reference/authorization-flow

This example demonstrates how to make a GET request to the Kobana API's userinfo endpoint using cURL. It includes essential headers such as Authorization with the bearer token, Content-Type, and User-Agent.

```curl
curl -i \
-H "Authorization: Bearer $KOBANA_TOKEN" \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET 'https://api-sandbox.kobana.com.br/v1/userinfo'
```

--------------------------------

### GET /websites/developers_kobana_br_v2_0_reference

Source: https://developers.kobana.com.br/v2.0/reference/get_v2-payment-bank-billets-uid-1

Retrieves specific details for a Boleto payment. Use this endpoint to get all the information associated with a particular Boleto payment.

```APIDOC
## GET /websites/developers_kobana_br_v2_0_reference

### Description
Retrieves specific details for a Boleto payment. Use this endpoint to get all the information associated with a particular Boleto payment.

### Method
GET

### Endpoint
/websites/developers_kobana_br_v2_0_reference

### Parameters
#### Query Parameters
- **paymentId** (string) - Required - The unique identifier for the Boleto payment.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **payment_id** (string) - The unique identifier of the payment.
- **status** (string) - The current status of the payment (e.g., "paid", "pending", "failed").
- **amount** (number) - The total amount of the payment.
- **due_date** (string) - The due date for the Boleto.
- **payer_name** (string) - The name of the person making the payment.
- **boleto_number** (string) - The Boleto number associated with the payment.

#### Response Example
```json
{
  "payment_id": "pay_123abc456def",
  "status": "paid",
  "amount": 150.75,
  "due_date": "2023-12-31",
  "payer_name": "John Doe",
  "boleto_number": "7009001234567890"
}
```
```

--------------------------------

### Customer Data Structure Example

Source: https://developers.kobana.com.br/v2.0/reference/get_v2-edi-edi-boxes

This snippet illustrates the structure of customer data, including contact information, external codes, tags, and custom data. It shows how addresses, emails, and phone numbers are organized within the customer object.

```json
{
  "customer": {
    "name": "Margret Santos Contas",
    "document": {
      "type": "cnpj",
      "value": "64164320000190"
    },
    "email": "margret.santos.contas@hand.test",
    "company_name": "Margret Santos Contas",
    "addresses": [
      {
        "type": "billing",
        "street": "Rua Ademar de Barros",
        "number": "117",
        "complement": null,
        "neighborhood": "Centro",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "zip_code": "24360440"
      }
    ],
    "emails": [
      {
        "label": null,
        "address": "jame@hand.test"
      }
    ],
    "phones": [
      {
        "kind": "landline",
        "country_code": "55",
        "local_code": "21",
        "number": "30030386"
      }
    ],
    "external_code": "000001",
    "tags": [
      "officiis",
      "placeat",
      "vel"
    ],
    "tag_list": "officiis,placeat,vel",
    "custom_data": {
      "numero_erp": 63126
    }
  }
}
```

--------------------------------

### Example ISPB Code

Source: https://developers.kobana.com.br/v2.0/reference/post_v2-transfer-ted-batches-1

Illustrates the ISPB code for banks, which can be inferred from COMPE if not provided. Examples show codes for Banco do Brasil, Bradesco, and Itaú.

```json
{
  "ispb": {
    "type": "string",
    "description": "Código ISPB do banco.\n\nSe não fornecido no input, será inferido automaticamente a partir do COMPE quando possível.\n\nExemplos: `0` (Banco do Brasil), `60746948` (Bradesco), `60701190` (Itaú)",
    "example": 60701190
  }
}
```

--------------------------------

### POST /v2/payment/utility_batches

Source: https://developers.kobana.com.br/v2.0/reference/post_v2-payment-utility-batches-1

Create a batch of utility payments. This endpoint is used to generate a payment batch. A prerequisite is to have a Financial Account registered. Webhook events `payment.batch.db.created` and `payment.utility_batch.confirmed` are dispatched.

```APIDOC
## POST /v2/payment/utility_batches

### Description
This endpoint is used to generate a batch of utility payments. A prerequisite is to have a Financial Account registered. The `payment.batch.db.created` event is dispatched upon batch creation. After the batch is confirmed by the financial institution, the `payment.utility_batch.confirmed` event is dispatched. The `payment.db.created` event is also dispatched if the batch contains a new payment.

### Method
POST

### Endpoint
/v2/payment/utility_batches

### Parameters
#### Header Parameters
- **User-Agent** (string) - Optional - Inform a valid email for contacts.
- **X-Idempotency-Key** (string) - Optional - Idempotency key to prevent processing replay.

### Request Example
```json
{
  "payments": [
    {
      "amount": 100.4,
      "utility": {
        "code": "00196994400000100040000003128557120985944917",
        "beneficiary": {
          "document_number": "34.414.342/0000-99"
        }
      }
    }
  ],
  "financial_account_uid": "019b7c10-501d-7db2-aa22-033f1fa7f00d"
}
```

### Response
#### Success Response (201)
- **status** (integer) - The HTTP status code.
- **data** (object) - The created batch payment details.
  - **uid** (string) - Unique identifier for the batch.
  - **status** (string) - Current status of the batch.
  - **registration_status** (string) - Registration status of the batch.
  - **financial_account_uid** (string) - UID of the associated financial account.
  - **created_at** (string) - Timestamp when the batch was created.
  - **updated_at** (string) - Timestamp when the batch was last updated.
  - **payments** (array) - List of payments within the batch.
    - **uid** (string) - Unique identifier for the payment.
    - **amount** (number) - Amount of the payment.
    - **scheduled_to** (string|null) - Date the payment is scheduled for.
    - **status** (string) - Status of the payment.
    - **registration_status** (string) - Registration status of the payment.
    - **financial_account_uid** (string) - UID of the associated financial account.
    - **confirmed_at** (string|null) - Timestamp when the payment was confirmed.
    - **rejected_error** (string|null) - Error message if the payment was rejected.
    - **rejected_at** (string|null) - Timestamp when the payment was rejected.
    - **transaction_code** (string|null) - Transaction code from the financial institution.
    - **transaction_date** (string|null) - Date of the transaction.
    - **source** (string) - Source of the payment (e.g., 'api').
    - **identifier** (string|null) - Payment identifier.
    - **external_id** (string|null) - External identifier for the payment.
    - **custom_data** (object|null) - Custom data associated with the payment.
    - **tags** (array) - List of tags associated with the payment.
    - **tag_list** (string|null) - A string representation of tags.
    - **created_at** (string) - Timestamp when the payment was created.
    - **updated_at** (string) - Timestamp when the payment was last updated.
    - **utility** (object) - Utility payment details.
      - **code** (string) - Utility payment code.
      - **beneficiary** (object) - Beneficiary details.
        - **name** (string|null) - Name of the beneficiary.
        - **document_number** (string) - Document number of the beneficiary.

#### Response Example
```json
{
  "status": 201,
  "data": {
    "uid": "019b7c10-5038-794c-a220-17501f7b457f",
    "status": "pending",
    "registration_status": "pending",
    "financial_account_uid": "019b7c10-501d-7db2-aa22-033f1fa7f00d",
    "created_at": "2026-01-02T12:16:42+12:00",
    "updated_at": "2026-01-02T12:16:42+12:00",
    "payments": [
      {
        "uid": "019b7c10-5037-7780-99e1-3fac57b3fa41",
        "amount": 100.4,
        "scheduled_to": null,
        "status": "pending",
        "registration_status": "pending",
        "financial_account_uid": "019b7c10-501d-7db2-aa22-033f1fa7f00d",
        "confirmed_at": null,
        "rejected_error": null,
        "rejected_at": null,
        "transaction_code": null,
        "transaction_date": null,
        "source": "api",
        "identifier": null,
        "external_id": null,
        "custom_data": null,
        "tags": [],
        "tag_list": null,
        "created_at": "2026-01-02T12:16:42+12:00",
        "updated_at": "2026-01-02T12:16:42+12:00",
        "utility": {
          "code": "00196994400000100040000003128557120985944917",
          "beneficiary": {
            "name": null,
            "document_number": "34.414.342/0000-99"
          }
        }
      },
      {
        "uid": "019b7c10-5038-7909-b723-7c129c500d6d",
        "amount": 100.4,
        "scheduled_to": null,
        "status": "pending",
        "registration_status": "pending",
        "financial_account_uid": "019b7c10-501d-7db2-aa22-033f1fa7f00d",
        "confirmed_at": null,
        "rejected_error": null,
        "rejected_at": null,
        "transaction_code": null,
        "transaction_date": null,
        "source": "api",
        "identifier": null,
        "external_id": null,
        "custom_data": null,
        "tags": [],
        "tag_list": null,
        "created_at": "2026-01-02T12:16:42+12:00",
        "updated_at": "2026-01-02T12:16:42+12:00",
        "utility": {
          "code": "00196994400000100040000003128557120985944917",
          "beneficiary": {
            "name": null,
            "document_number": "34.414.342/0000-99"
          }
        }
      }
    ]
  }
}
```

--------------------------------

### GET /websites/developers_kobana_br_v2_0_reference/commands

Source: https://developers.kobana.com.br/v2.0/reference/put_v2-charge-pix-pix-uid-cancel-1

Retrieves a list of commands, potentially with filters for status, operation, and creation date. Supports pagination.

```APIDOC
## GET /websites/developers_kobana_br_v2_0_reference/commands

### Description
Retrieves a list of commands.

### Method
GET

### Endpoint
/websites/developers_kobana_br_v2_0_reference/commands

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter commands by their status (e.g., `pending`, `confirmed`, `failed`).
- **operation** (string) - Optional - Filter commands by their operation type (e.g., `update`, `cancel`, `destroy`).
- **created_after** (string) - Optional - Filter commands created after a specific date-time (ISO 8601 format).
- **created_before** (string) - Optional - Filter commands created before a specific date-time (ISO 8601 format).
- **page** (integer) - Optional - Page number for pagination. Defaults to 1.
- **limit** (integer) - Optional - Number of items per page. Defaults to 10.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **status** (integer) - HTTP status code.
- **data** (array) - An array of command objects.
  - **id** (integer) - ReadOnly - ID of the Command.
  - **status** (string) - ReadOnly - Status of the command (`pending`, `confirmed`, `failed`).
  - **operation** (string) - ReadOnly - Type of operation (`update`, `cancel`, `destroy`).
  - **params** (object) - ReadOnly, Nullable - Parameters for the Command execution.
  - **payload** (object) - ReadOnly, Nullable - Server response with the operation result.
  - **created_at** (string) - ReadOnly - Date the Command record was created.
  - **updated_at** (string) - ReadOnly - Date the Command record was updated.
  - **pix** (object) - ReadOnly - Pix payment details.
    - **uid** (string) - ReadOnly - UID of the Pix.
    - **amount** (number) - Amount in BRL.
    - **payer** (object) - Payer details.
      - **document_number** (string) - Document Number (CPF or CNPJ).
      - **name** (string) - Full Name or Company Name.
      - **email** (string) - Nullable - Payer's email.
      - **address** (object) - Nullable - Payer's address.
        - **street** (string) - Street name.
        - **number** (string) - House number.
        - **neighborhood** (string) - Neighborhood.
        - **city** (string) - City.
        - **state** (string) - State (e.g., 'SP').
        - **zipcode** (string) - Postal code.

#### Response Example
```json
{
  "status": 200,
  "data": [
    {
      "id": 123,
      "status": "confirmed",
      "operation": "update",
      "params": {},
      "payload": {},
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:05:00Z",
      "pix": {
        "uid": "018df180-7208-727b-a10a-ea545e4a75a8",
        "amount": 120.99,
        "payer": {
          "document_number": "111.321.322-09",
          "name": "João da Silva",
          "email": "joao@example.com",
          "address": {
            "street": "Rua Principal",
            "number": "123",
            "neighborhood": "Centro",
            "city": "São Paulo",
            "state": "SP",
            "zipcode": "01000-000"
          }
        }
      }
    }
  ]
}
```
```

--------------------------------

### 404 Not Found Example

Source: https://developers.kobana.com.br/v2.0/reference/put_v2-charge-automatic-pix-pix-uid-retry

Example of a 404 Not Found response, indicating that a requested resource, such as an automatic PIX charge, could not be found.

```APIDOC
## GET /resource/{id}

### Description
Retrieves a specific resource by its ID.

### Method
GET

### Endpoint
`/resource/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the resource.

### Response
#### Error Response (404)
- **status** (integer) - The HTTP status code, which is 404.
- **errors** (array) - An array containing error objects detailing why the resource was not found.
  - **title** (string) - A message indicating that the record could not be found.

### Response Example (404)
```json
{
  "status": 404,
  "errors": [
    {
      "title": "Não foi possível encontrar o registro"
    }
  ]
}
```
```

--------------------------------

### PUT /websites/developers_kobana_br_v2_0_reference

Source: https://developers.kobana.com.br/v2.0/reference/put_v2-financial-accounts-id-1

Atualiza os detalhes de uma Conta Financeira específica. Você precisa fornecer o ID da conta a ser atualizada e os novos dados no corpo da requisição.

```APIDOC
## PUT /websites/developers_kobana_br_v2_0_reference

### Description
Atualiza uma Conta Financeira específica. Forneça o ID da conta e os dados atualizados no corpo da requisição.

### Method
PUT

### Endpoint
`/websites/developers_kobana_br_v2_0_reference`

### Parameters
#### Path Parameters
Nenhum parâmetro de caminho para este endpoint.

#### Query Parameters
Nenhum parâmetro de consulta para este endpoint.

#### Request Body
- **id** (string) - Required - O identificador único da conta a ser atualizada.
- **nome** (string) - Optional - O novo nome da conta.
- **saldo** (number) - Optional - O novo saldo da conta.

### Request Example
```json
{
  "id": "conta-123",
  "nome": "Conta Corrente Atualizada",
  "saldo": 5000.50
}
```

### Response
#### Success Response (200)
- **message** (string) - Mensagem de sucesso indicando que a conta foi atualizada.

#### Response Example
```json
{
  "message": "Conta atualizada com sucesso."
}
```
```